@aws-cdk/aws-ec2¶
AWS Compute and Networking Construct Library¶
The @aws-cdk/aws-ec2 package contains primitives for setting up networking and
instances.
VPC¶
Most projects need a Virtual Private Cloud to provide security by means of
network partitioning. This is easily achieved by creating an instance of
VpcNetwork:
import ec2 = require('@aws-cdk/aws-ec2');
const vpc = new ec2.VpcNetwork(this, 'VPC');
All default Constructs requires EC2 instances to be launched inside a VPC, so you should generally start by defining a VPC whenever you need to launch instances for your project.
Our default VpcNetwork class creates a private and public subnet for every
availability zone. Classes that use the VPC will generally launch instances
into all private subnets, and provide a parameter called vpcPlacement to
allow you to override the placement. Read more about
subnets.
Advanced Subnet Configuration¶
If you require the ability to configure subnets the VpcNetwork can be
customized with SubnetConfiguration array. This is best explained by an
example:
import ec2 = require('@aws-cdk/aws-ec2');
const vpc = new ec2.VpcNetwork(stack, 'TheVPC', {
cidr: '10.0.0.0/21',
subnetConfiguration: [
{
cidrMask: 24,
name: 'Ingress',
subnetType: SubnetType.Public,
},
{
cidrMask: 24,
name: 'Application',
subnetType: SubnetType.Private,
},
{
cidrMask: 28,
name: 'Database',
subnetType: SubnetType.Isolated,
}
],
});
The example above is one possible configuration, but the user can use the constructs above to implement many other network configurations.
The VpcNetwork from the above configuration in a Region with three
availability zones will be the following:
- IngressSubnet1: 10.0.0.0/24
- IngressSubnet2: 10.0.1.0/24
- IngressSubnet3: 10.0.2.0/24
- ApplicationSubnet1: 10.0.3.0/24
- ApplicationSubnet2: 10.0.4.0/24
- ApplicationSubnet3: 10.0.5.0/24
- DatabaseSubnet1: 10.0.6.0/28
- DatabaseSubnet2: 10.0.6.16/28
- DatabaseSubnet3: 10.0.6.32/28
Each Public Subnet will have a NAT Gateway. Each Private Subnet will have a
route to the NAT Gateway in the same availability zone. Each Isolated subnet
will not have a route to the internet, but is routeable inside the VPC. The
numbers [1-3] will consistently map to availability zones (e.g. IngressSubnet1
and ApplicationSubnet1 will be in the same avialbility zone).
Isolated Subnets provide simplified secure networking principles, but come at
an operational complexity. The lack of an internet route means that if you deploy
instances in this subnet you will not be able to patch from the internet, this is
commonly reffered to as
fully baked images.
Features such as
cfn-signal
are also unavailable. Using these subnets for managed services (RDS,
Elasticache, Redshift) is a very practical use because the managed services do
not incur additional operational overhead.
Many times when you plan to build an application you don’t know how many instances of the application you will need and therefore you don’t know how much IP space to allocate. For example, you know the application will only have Elastic Loadbalancers in the public subnets and you know you will have 1-3 RDS databases for your data tier, and the rest of the IP space should just be evenly distributed for the application.
import ec2 = require('@aws-cdk/aws-ec2');
const vpc = new ec2.VpcNetwork(stack, 'TheVPC', {
cidr: '10.0.0.0/16',
natGateways: 1,
subnetConfiguration: [
{
cidrMask: 26,
name: 'Public',
subnetType: SubnetType.Public,
},
{
name: 'Application',
subnetType: SubnetType.Private,
},
{
cidrMask: 27,
name: 'Database',
subnetType: SubnetType.Isolated,
}
],
});
The VpcNetwork from the above configuration in a Region with three
availability zones will be the following:
- PublicSubnet1: 10.0.0.0/26
- PublicSubnet2: 10.0.0.64/26
- PublicSubnet3: 10.0.2.128/26
- DatabaseSubnet1: 10.0.0.192/27
- DatabaseSubnet2: 10.0.0.224/27
- DatabaseSubnet3: 10.0.1.0/27
- ApplicationSubnet1: 10.0.64.0/18
- ApplicationSubnet2: 10.0.128.0/18
- ApplicationSubnet3: 10.0.192.0/18
Any subnet configuration without a cidrMask will be counted up and allocated
evenly across the remaining IP space.
Teams may also become cost conscious and be willing to trade availability for cost. For example, in your test environments perhaps you would like the same VPC as production, but instead of 3 NAT Gateways you would like only 1. This will save on the cost, but trade the 3 availability zone to a 1 for all egress traffic. This can be accomplished with a single parameter configuration:
import ec2 = require('@aws-cdk/aws-ec2');
const vpc = new ec2.VpcNetwork(stack, 'TheVPC', {
cidr: '10.0.0.0/16',
natGateways: 1,
natGatewayPlacement: {subnetName: 'Public'},
subnetConfiguration: [
{
cidrMask: 26,
name: 'Public',
subnetType: SubnetType.Public,
natGateway: true,
},
{
name: 'Application',
subnetType: SubnetType.Private,
},
{
cidrMask: 27,
name: 'Database',
subnetType: SubnetType.Isolated,
}
],
});
The VpcNetwork above will have the exact same subnet definitions as listed
above. However, this time the VPC will have only 1 NAT Gateway and all
Application subnets will route to the NAT Gateway.
Sharing VPCs across stacks¶
If you are creating multiple Stacks inside the same CDK application, you
can reuse a VPC defined in one Stack in another by using export() and
import():
class Stack1 extends cdk.Stack {
public readonly vpcProps: ec2.VpcNetworkRefProps;
constructor(parent: cdk.App, id: string, props?: cdk.StackProps) {
super(parent, id, props);
const vpc = new ec2.VpcNetwork(this, 'VPC');
// Export the VPC to a set of properties
this.vpcProps = vpc.export();
}
}
interface Stack2Props extends cdk.StackProps {
vpcProps: ec2.VpcNetworkRefProps;
}
class Stack2 extends cdk.Stack {
constructor(parent: cdk.App, id: string, props: Stack2Props) {
super(parent, id, props);
// Import the VPC from a set of properties
const vpc = ec2.VpcNetworkRef.import(this, 'VPC', props.vpcProps);
new ConstructThatTakesAVpc(this, 'Construct', {
vpc
});
}
}
const stack1 = new Stack1(app, 'Stack1');
const stack2 = new Stack2(app, 'Stack2', {
vpcProps: stack1.vpcProps
});
If your VPC is created outside your CDK app, you can use importFromContext():
const vpc = ec2.VpcNetworkRef.importFromContext(stack, 'VPC', {
// This imports the default VPC but you can also
// specify a 'vpcName' or 'tags'.
isDefault: true
});
Allowing Connections¶
In AWS, all network traffic in and out of Elastic Network Interfaces (ENIs)
is controlled by Security Groups. You can think of Security Groups as a
firewall with a set of rules. By default, Security Groups allow no incoming
(ingress) traffic and all outgoing (egress) traffic. You can add ingress rules
to them to allow incoming traffic streams. To exert fine-grained control over
egress traffic, set allowAllOutbound: false on the SecurityGroup, after
which you can add egress traffic rules.
You can manipulate Security Groups directly:
const mySecurityGroup = new ec2.SecurityGroup(this, 'SecurityGroup', {
vpc,
description: 'Allow ssh access to ec2 instances',
allowAllOutbound: true // Can be set to false
});
mySecurityGroup.addIngressRule(new ec2.AnyIPv4(), new ec2.TcpPort(22), 'allow ssh access from the world');
All constructs that create ENIs on your behalf (typically constructs that create EC2 instances or other VPC-connected resources) will all have security groups automatically assigned. Those constructs have an attribute called connections, which is an object that makes it convenient to update the security groups. If you want to allow connections between two constructs that have security groups, you have to add an Egress rule to one Security Group, and an Ingress rule to the other. The connections object will automatically take care of this for you:
// Allow connections from anywhere
loadBalancer.connections.allowFromAnyIpv4(new ec2.TcpPort(443), 'Allow inbound HTTPS');
// The same, but an explicit IP address
loadBalancer.connections.allowFrom(new ec2.CidrIpv4('1.2.3.4/32'), new ec2.TcpPort(443), 'Allow inbound HTTPS');
// Allow connection between AutoScalingGroups
appFleet.connections.allowTo(dbFleet, new ec2.TcpPort(443), 'App can call database');
Connection Peers¶
There are various classes that implement the connection peer part:
// Simple connection peers
let peer = new ec2.CidrIp("10.0.0.0/16");
let peer = new ec2.AnyIPv4();
let peer = new ec2.CidrIpv6("::0/0");
let peer = new ec2.AnyIPv6();
let peer = new ec2.PrefixList("pl-12345");
fleet.connections.allowTo(peer, new ec2.TcpPort(443), 'Allow outbound HTTPS');
Any object that has a security group can itself be used as a connection peer:
// These automatically create appropriate ingress and egress rules in both security groups
fleet1.connections.allowTo(fleet2, new ec2.TcpPort(80), 'Allow between fleets');
fleet.connections.allowTcpPort(80), 'Allow from load balancer');
Port Ranges¶
The connections that are allowed are specified by port ranges. A number of classes provide the connection specifier:
new ec2.TcpPort(80)
new ec2.TcpPortRange(60000, 65535)
new ec2.TcpAllPorts()
new ec2.AllConnections()
NOTE: This set is not complete yet; for example, there is no library support for ICMP at the moment. However, you can write your own classes to implement those.
Default Ports¶
Some Constructs have default ports associated with them. For example, the listener of a load balancer does (it’s the public port), or instances of an RDS database (it’s the port the database is accepting connections on).
If the object you’re calling the peering method on has a default port associated with it, you can call
allowDefaultPortFrom() and omit the port specifier. If the argument has an associated default port, call
allowToDefaultPort().
For example:
// Port implicit in listener
listener.connections.allowDefaultPortFromAnyIpv4('Allow public');
// Port implicit in peer
fleet.connections.allowToDefaultPort(rdsDatabase, 'Fleet can access database');
Machine Images (AMIs)¶
AMIs control the OS that gets launched when you start your EC2 instance. The EC2 library contains constructs to select the AMI you want to use.
Depending on the type of AMI, you select it a different way.
The latest version of Amazon Linux and Microsoft Windows images are selectable by instantiating one of these classes:
// Pick a Windows edition to use
const windows = new ec2.WindowsImage(ec2.WindowsVersion.WindowsServer2016EnglishNanoBase);
// Pick the right Amazon Linux edition. All arguments shown are optional
// and will default to these values when omitted.
const amznLinux = new ec2.AmazonLinuxImage({
generation: ec2.AmazonLinuxGeneration.AmazonLinux,
edition: ec2.AmazonLinuxEdition.Standard,
virtualization: ec2.AmazonLinuxVirt.HVM,
storage: ec2.AmazonLinuxStorage.GeneralPurpose,
});
// For other custom (Linux) images, instantiate a `GenericLinuxImage` with
// a map giving the AMI to in for each region:
const linux = new ec2.GenericLinuxImage({
'us-east-1': 'ami-97785bed',
'eu-west-1': 'ami-12345678',
// ...
});
NOTE: The Amazon Linux images selected will be cached in your
cdk.json, so that your AutoScalingGroups don’t automatically change out from under you when you’re making unrelated changes. To update to the latest version of Amazon Linux, remove the cache entry from thecontextsection of yourcdk.json.We will add command-line options to make this step easier in the future.
Reference¶
View in Nuget
csproj:
<PackageReference Include="Amazon.CDK.AWS.EC2" Version="0.19.0" />
dotnet:
dotnet add package Amazon.CDK.AWS.EC2 --version 0.19.0
packages.config:
<package id="Amazon.CDK.AWS.EC2" version="0.19.0" />
View in Maven Central
Apache Buildr:
'software.amazon.awscdk:ec2:jar:0.19.0'
Apache Ivy:
<dependency groupId="software.amazon.awscdk" name="ec2" rev="0.19.0"/>
Apache Maven:
<dependency>
<groupId>software.amazon.awscdk</groupId>
<artifactId>ec2</artifactId>
<version>0.19.0</version>
</dependency>
Gradle / Grails:
compile 'software.amazon.awscdk:ec2:0.19.0'
Groovy Grape:
@Grapes(
@Grab(group='software.amazon.awscdk', module='ec2', version='0.19.0')
)
View in NPM
npm:
$ npm i @aws-cdk/aws-ec2@0.19.0
package.json:
{
"@aws-cdk/aws-ec2": "^0.19.0"
}
yarn:
$ yarn add @aws-cdk/aws-ec2@0.19.0
View in NPM
npm:
$ npm i @aws-cdk/aws-ec2@0.19.0
package.json:
{
"@aws-cdk/aws-ec2": "^0.19.0"
}
yarn:
$ yarn add @aws-cdk/aws-ec2@0.19.0
AllTraffic¶
-
class
@aws-cdk/aws-ec2.AllTraffic¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AllTraffic;
const { AllTraffic } = require('@aws-cdk/aws-ec2');
import { AllTraffic } from '@aws-cdk/aws-ec2';
All Traffic
Implements: IPortRange-
toRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.IPortRange.toRuleJSON()Produce the ingress/egress rule JSON for the given connection
Return type: any
-
toString() → string¶ Returns a string representation of an object.
Return type: string
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.IPortRange.canInlineRule()Whether the rule containing this port range can be inlined into a securitygroup or not.
Type: boolean (readonly)
-
AmazonLinuxEdition (enum)¶
-
class
@aws-cdk/aws-ec2.AmazonLinuxEdition¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxEdition;
const { AmazonLinuxEdition } = require('@aws-cdk/aws-ec2');
import { AmazonLinuxEdition } from '@aws-cdk/aws-ec2';
Amazon Linux edition
-
Standard¶
Standard edition
-
Minimal¶
Minimal edition
-
AmazonLinuxGeneration (enum)¶
-
class
@aws-cdk/aws-ec2.AmazonLinuxGeneration¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxGeneration;
const { AmazonLinuxGeneration } = require('@aws-cdk/aws-ec2');
import { AmazonLinuxGeneration } from '@aws-cdk/aws-ec2';
What generation of Amazon Linux to use
-
AmazonLinux¶
Amazon Linux
-
AmazonLinux2¶
Amazon Linux 2
-
AmazonLinuxImage¶
-
class
@aws-cdk/aws-ec2.AmazonLinuxImage([props])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxImage;
const { AmazonLinuxImage } = require('@aws-cdk/aws-ec2');
import { AmazonLinuxImage } from '@aws-cdk/aws-ec2';
Selects the latest version of Amazon Linux
The AMI ID is selected using the values published to the SSM parameter store.
Implements: IMachineImageSourceParameters: props ( AmazonLinuxImageProps(optional)) –-
getImage(parent) → @aws-cdk/aws-ec2.MachineImage¶ Implements
@aws-cdk/aws-ec2.IMachineImageSource.getImage()Return the image to use in the given context
Parameters: parent ( @aws-cdk/cdk.Construct) –Return type: MachineImage
-
AmazonLinuxImageProps (interface)¶
-
class
@aws-cdk/aws-ec2.AmazonLinuxImageProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxImageProps;
// AmazonLinuxImageProps is an interfaceimport { AmazonLinuxImageProps } from '@aws-cdk/aws-ec2';
Amazon Linux image properties
-
edition¶ What edition of Amazon Linux to use
Type: AmazonLinuxEdition(optional)Default: Standard
-
generation¶ What generation of Amazon Linux to use
Type: AmazonLinuxGeneration(optional)Default: AmazonLinux
-
storage¶ What storage backed image to use
Type: AmazonLinuxStorage(optional)Default: GeneralPurpose
-
virtualization¶ Virtualization type
Type: AmazonLinuxVirt(optional)Default: HVM
-
AmazonLinuxStorage (enum)¶
-
class
@aws-cdk/aws-ec2.AmazonLinuxStorage¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxStorage;
const { AmazonLinuxStorage } = require('@aws-cdk/aws-ec2');
import { AmazonLinuxStorage } from '@aws-cdk/aws-ec2';
-
EBS¶
EBS-backed storage
-
GeneralPurpose¶
General Purpose-based storage (recommended)
-
AmazonLinuxVirt (enum)¶
-
class
@aws-cdk/aws-ec2.AmazonLinuxVirt¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AmazonLinuxVirt;
const { AmazonLinuxVirt } = require('@aws-cdk/aws-ec2');
import { AmazonLinuxVirt } from '@aws-cdk/aws-ec2';
Virtualization type for Amazon Linux
-
HVM¶
HVM virtualization (recommended)
-
PV¶
PV virtualization
-
AnyIPv4¶
-
class
@aws-cdk/aws-ec2.AnyIPv4¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AnyIPv4;
const { AnyIPv4 } = require('@aws-cdk/aws-ec2');
import { AnyIPv4 } from '@aws-cdk/aws-ec2';
Any IPv4 address
Extends: CidrIPv4-
toEgressRuleJSON() → any¶ Inherited from
@aws-cdk/aws-ec2.CidrIPv4Produce the egress rule JSON for the given connection
Return type: any
-
toIngressRuleJSON() → any¶ Inherited from
@aws-cdk/aws-ec2.CidrIPv4Produce the ingress rule JSON for the given connection
Return type: any
-
canInlineRule¶ Inherited from
@aws-cdk/aws-ec2.CidrIPv4Whether the rule can be inlined into a SecurityGroup or not
Type: boolean (readonly)
-
cidrIp¶ Inherited from
@aws-cdk/aws-ec2.CidrIPv4Type: string (readonly)
-
connections¶ Inherited from
@aws-cdk/aws-ec2.CidrIPv4Type: Connections(readonly)
-
uniqueId¶ Inherited from
@aws-cdk/aws-ec2.CidrIPv4A unique identifier for this connection peer
Type: string (readonly)
-
AnyIPv6¶
-
class
@aws-cdk/aws-ec2.AnyIPv6¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.AnyIPv6;
const { AnyIPv6 } = require('@aws-cdk/aws-ec2');
import { AnyIPv6 } from '@aws-cdk/aws-ec2';
Any IPv6 address
Extends: CidrIPv6-
toEgressRuleJSON() → any¶ Inherited from
@aws-cdk/aws-ec2.CidrIPv6Produce the egress rule JSON for the given connection
Return type: any
-
toIngressRuleJSON() → any¶ Inherited from
@aws-cdk/aws-ec2.CidrIPv6Produce the ingress rule JSON for the given connection
Return type: any
-
canInlineRule¶ Inherited from
@aws-cdk/aws-ec2.CidrIPv6Whether the rule can be inlined into a SecurityGroup or not
Type: boolean (readonly)
-
cidrIpv6¶ Inherited from
@aws-cdk/aws-ec2.CidrIPv6Type: string (readonly)
-
connections¶ Inherited from
@aws-cdk/aws-ec2.CidrIPv6Type: Connections(readonly)
-
uniqueId¶ Inherited from
@aws-cdk/aws-ec2.CidrIPv6A unique identifier for this connection peer
Type: string (readonly)
-
CidrIPv4¶
-
class
@aws-cdk/aws-ec2.CidrIPv4(cidrIp)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CidrIPv4;
const { CidrIPv4 } = require('@aws-cdk/aws-ec2');
import { CidrIPv4 } from '@aws-cdk/aws-ec2';
A connection to and from a given IP range
Implements: ISecurityGroupRuleImplements: IConnectableParameters: cidrIp (string) – -
toEgressRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.toEgressRuleJSON()Produce the egress rule JSON for the given connection
Return type: any
-
toIngressRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.toIngressRuleJSON()Produce the ingress rule JSON for the given connection
Return type: any
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.canInlineRule()Whether the rule can be inlined into a SecurityGroup or not
Type: boolean (readonly)
-
cidrIp¶ Type: string (readonly)
-
connections¶ Implements
@aws-cdk/aws-ec2.IConnectable.connections()Type: Connections(readonly)
-
uniqueId¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.uniqueId()A unique identifier for this connection peer
Type: string (readonly)
-
CidrIPv6¶
-
class
@aws-cdk/aws-ec2.CidrIPv6(cidrIpv6)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.CidrIPv6;
const { CidrIPv6 } = require('@aws-cdk/aws-ec2');
import { CidrIPv6 } from '@aws-cdk/aws-ec2';
A connection to a from a given IPv6 range
Implements: ISecurityGroupRuleImplements: IConnectableParameters: cidrIpv6 (string) – -
toEgressRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.toEgressRuleJSON()Produce the egress rule JSON for the given connection
Return type: any
-
toIngressRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.toIngressRuleJSON()Produce the ingress rule JSON for the given connection
Return type: any
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.canInlineRule()Whether the rule can be inlined into a SecurityGroup or not
Type: boolean (readonly)
-
cidrIpv6¶ Type: string (readonly)
-
connections¶ Implements
@aws-cdk/aws-ec2.IConnectable.connections()Type: Connections(readonly)
-
uniqueId¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.uniqueId()A unique identifier for this connection peer
Type: string (readonly)
-
ConnectionRule (interface)¶
-
class
@aws-cdk/aws-ec2.ConnectionRule¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.ConnectionRule;
// ConnectionRule is an interfaceimport { ConnectionRule } from '@aws-cdk/aws-ec2';
-
fromPort¶ Start of port range for the TCP and UDP protocols, or an ICMP type number.
If you specify icmp for the IpProtocol property, you can specify
-1 as a wildcard (i.e., any ICMP type number).
Type: number
-
description¶ Description of this connection. It is applied to both the ingress rule
and the egress rule.
Type: string (optional) Default: No description
-
protocol¶ The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).
Use -1 to specify all protocols. If you specify -1, or a protocol number
other than tcp, udp, icmp, or 58 (ICMPv6), traffic on all ports is
allowed, regardless of any ports you specify. For tcp, udp, and icmp, you
must specify a port range. For protocol 58 (ICMPv6), you can optionally
specify a port range; if you don’t, traffic for all types and codes is
allowed.
Type: string (optional) Default: tcp
-
toPort¶ End of port range for the TCP and UDP protocols, or an ICMP code.
If you specify icmp for the IpProtocol property, you can specify -1 as a
wildcard (i.e., any ICMP code).
Type: number (optional) Default: If toPort is not specified, it will be the same as fromPort.
-
Connections¶
-
class
@aws-cdk/aws-ec2.Connections([props])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.Connections;
const { Connections } = require('@aws-cdk/aws-ec2');
import { Connections } from '@aws-cdk/aws-ec2';
Manage the allowed network connections for constructs with Security Groups.
Security Groups can be thought of as a firewall for network-connected
devices. This class makes it easy to allow network connections to and
from security groups, and between security groups individually. When
establishing connectivity between security groups, it will automatically
add rules in both security groups
This object can manage one or more security groups.
Implements: IConnectableParameters: props ( ConnectionsProps(optional)) –-
addSecurityGroup(*securityGroups)¶ Add a security group to the list of security groups managed by this object
Parameters: *securityGroups ( SecurityGroupRef) –
-
allowDefaultPortFrom(other[, description])¶ Allow connections from the peer on our default port
Even if the peer has a default port, we will always use our default port.
Parameters: - other (
IConnectable) – - description (string (optional)) –
- other (
-
allowDefaultPortFromAnyIpv4([description])¶ Allow default connections from all IPv4 ranges
Parameters: description (string (optional)) –
-
allowDefaultPortInternally([description])¶ Allow hosts inside the security group to connect to each other
Parameters: description (string (optional)) –
-
allowDefaultPortTo(other[, description])¶ Allow connections from the peer on our default port
Even if the peer has a default port, we will always use our default port.
Parameters: - other (
IConnectable) – - description (string (optional)) –
- other (
-
allowFrom(other, portRange[, description])¶ Allow connections from the peer on the given port
Parameters: - other (
IConnectable) – - portRange (
IPortRange) – - description (string (optional)) –
- other (
-
allowFromAnyIPv4(portRange[, description])¶ Allow from any IPv4 ranges
Parameters: - portRange (
IPortRange) – - description (string (optional)) –
- portRange (
-
allowInternally(portRange[, description])¶ Allow hosts inside the security group to connect to each other on the given port
Parameters: - portRange (
IPortRange) – - description (string (optional)) –
- portRange (
-
allowTo(other, portRange[, description])¶ Allow connections to the peer on the given port
Parameters: - other (
IConnectable) – - portRange (
IPortRange) – - description (string (optional)) –
- other (
-
allowToAnyIPv4(portRange[, description])¶ Allow to all IPv4 ranges
Parameters: - portRange (
IPortRange) – - description (string (optional)) –
- portRange (
-
allowToDefaultPort(other[, description])¶ Allow connections to the security group on their default port
Parameters: - other (
IConnectable) – - description (string (optional)) –
- other (
-
connections¶ Implements
@aws-cdk/aws-ec2.IConnectable.connections()Type: Connections(readonly)
-
securityGroups¶ Type: SecurityGroupRef[] (readonly)
-
defaultPortRange¶ The default port configured for this connection peer, if available
Type: IPortRange(optional) (readonly)
-
ConnectionsProps (interface)¶
-
class
@aws-cdk/aws-ec2.ConnectionsProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.ConnectionsProps;
// ConnectionsProps is an interfaceimport { ConnectionsProps } from '@aws-cdk/aws-ec2';
Properties to intialize a new Connections object
-
defaultPortRange¶ Default port range for initiating connections to and from this object
Type: IPortRange(optional)Default: No default port range
-
securityGroupRule¶ Class that represents the rule by which others can connect to this connectable
This object is required, but will be derived from securityGroup if that is passed.
Type: ISecurityGroupRule(optional)Default: Derived from securityGroup if set.
-
securityGroups¶ What securityGroup(s) this object is managing connections for
Type: SecurityGroupRef[] (optional)Default: No security groups
-
DefaultInstanceTenancy (enum)¶
-
class
@aws-cdk/aws-ec2.DefaultInstanceTenancy¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.DefaultInstanceTenancy;
const { DefaultInstanceTenancy } = require('@aws-cdk/aws-ec2');
import { DefaultInstanceTenancy } from '@aws-cdk/aws-ec2';
The default tenancy of instances launched into the VPC.
-
Default¶
Instances can be launched with any tenancy.
-
Dedicated¶
Any instance launched into the VPC automatically has dedicated tenancy, unless you launch it with the default tenancy.
-
GenericLinuxImage¶
-
class
@aws-cdk/aws-ec2.GenericLinuxImage(amiMap)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.GenericLinuxImage;
const { GenericLinuxImage } = require('@aws-cdk/aws-ec2');
import { GenericLinuxImage } from '@aws-cdk/aws-ec2';
Construct a Linux machine image from an AMI map
Linux images IDs are not published to SSM parameter store yet, so you’ll have to
manually specify an AMI map.
Implements: IMachineImageSourceParameters: amiMap (string => string) – -
getImage(parent) → @aws-cdk/aws-ec2.MachineImage¶ Implements
@aws-cdk/aws-ec2.IMachineImageSource.getImage()Return the image to use in the given context
Parameters: parent ( @aws-cdk/cdk.Construct) –Return type: MachineImage
-
amiMap¶ Type: string => string (readonly)
-
IConnectable (interface)¶
-
class
@aws-cdk/aws-ec2.IConnectable¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.IConnectable;
// IConnectable is an interfaceimport { IConnectable } from '@aws-cdk/aws-ec2';
The goal of this module is to make possible to write statements like this:
The insight here is that some connecting peers have information on what ports should
be involved in the connection, and some don’t.
An object that has a Connections object
-
connections¶ Type: Connections(readonly)
-
IMachineImageSource (interface)¶
-
class
@aws-cdk/aws-ec2.IMachineImageSource¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.IMachineImageSource;
// IMachineImageSource is an interfaceimport { IMachineImageSource } from '@aws-cdk/aws-ec2';
Interface for classes that can select an appropriate machine image to use
-
getImage(parent) → @aws-cdk/aws-ec2.MachineImage¶ Return the image to use in the given context
Parameters: parent ( @aws-cdk/cdk.Construct) –Return type: MachineImageAbstract: Yes
-
IPortRange (interface)¶
-
class
@aws-cdk/aws-ec2.IPortRange¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.IPortRange;
// IPortRange is an interfaceimport { IPortRange } from '@aws-cdk/aws-ec2';
Interface for classes that provide the connection-specification parts of a security group rule
-
canInlineRule¶ Whether the rule containing this port range can be inlined into a securitygroup or not.
Type: boolean (readonly)
-
toRuleJSON() → any¶ Produce the ingress/egress rule JSON for the given connection
Return type: any Abstract: Yes
-
ISecurityGroupRule (interface)¶
-
class
@aws-cdk/aws-ec2.ISecurityGroupRule¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.ISecurityGroupRule;
// ISecurityGroupRule is an interfaceimport { ISecurityGroupRule } from '@aws-cdk/aws-ec2';
Interface for classes that provide the peer-specification parts of a security group rule
-
canInlineRule¶ Whether the rule can be inlined into a SecurityGroup or not
Type: boolean (readonly)
-
uniqueId¶ A unique identifier for this connection peer
Type: string (readonly)
-
toEgressRuleJSON() → any¶ Produce the egress rule JSON for the given connection
Return type: any Abstract: Yes
-
toIngressRuleJSON() → any¶ Produce the ingress rule JSON for the given connection
Return type: any Abstract: Yes
-
IcmpAllTypeCodes¶
-
class
@aws-cdk/aws-ec2.IcmpAllTypeCodes(type)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.IcmpAllTypeCodes;
const { IcmpAllTypeCodes } = require('@aws-cdk/aws-ec2');
import { IcmpAllTypeCodes } from '@aws-cdk/aws-ec2';
All ICMP Codes for a given ICMP Type
Implements: IPortRangeParameters: type (number) – -
toRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.IPortRange.toRuleJSON()Produce the ingress/egress rule JSON for the given connection
Return type: any
-
toString() → string¶ Returns a string representation of an object.
Return type: string
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.IPortRange.canInlineRule()Whether the rule containing this port range can be inlined into a securitygroup or not.
Type: boolean (readonly)
-
type¶ Type: number (readonly)
-
IcmpAllTypesAndCodes¶
-
class
@aws-cdk/aws-ec2.IcmpAllTypesAndCodes¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.IcmpAllTypesAndCodes;
const { IcmpAllTypesAndCodes } = require('@aws-cdk/aws-ec2');
import { IcmpAllTypesAndCodes } from '@aws-cdk/aws-ec2';
All ICMP Types & Codes
Implements: IPortRange-
toRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.IPortRange.toRuleJSON()Produce the ingress/egress rule JSON for the given connection
Return type: any
-
toString() → string¶ Returns a string representation of an object.
Return type: string
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.IPortRange.canInlineRule()Whether the rule containing this port range can be inlined into a securitygroup or not.
Type: boolean (readonly)
-
IcmpPing¶
-
class
@aws-cdk/aws-ec2.IcmpPing¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.IcmpPing;
const { IcmpPing } = require('@aws-cdk/aws-ec2');
import { IcmpPing } from '@aws-cdk/aws-ec2';
ICMP Ping traffic
Implements: IPortRange-
toRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.IPortRange.toRuleJSON()Produce the ingress/egress rule JSON for the given connection
Return type: any
-
toString() → string¶ Returns a string representation of an object.
Return type: string
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.IPortRange.canInlineRule()Whether the rule containing this port range can be inlined into a securitygroup or not.
Type: boolean (readonly)
-
IcmpTypeAndCode¶
-
class
@aws-cdk/aws-ec2.IcmpTypeAndCode(type, code)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.IcmpTypeAndCode;
const { IcmpTypeAndCode } = require('@aws-cdk/aws-ec2');
import { IcmpTypeAndCode } from '@aws-cdk/aws-ec2';
A set of matching ICMP Type & Code
Implements: Parameters: - type (number) –
- code (number) –
-
toRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.IPortRange.toRuleJSON()Produce the ingress/egress rule JSON for the given connection
Return type: any
-
toString() → string¶ Returns a string representation of an object.
Return type: string
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.IPortRange.canInlineRule()Whether the rule containing this port range can be inlined into a securitygroup or not.
Type: boolean (readonly)
-
code¶ Type: number (readonly)
-
type¶ Type: number (readonly)
InstanceClass (enum)¶
-
class
@aws-cdk/aws-ec2.InstanceClass¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.InstanceClass;
const { InstanceClass } = require('@aws-cdk/aws-ec2');
import { InstanceClass } from '@aws-cdk/aws-ec2';
What class and generation of instance to use
We have both symbolic and concrete enums for every type.
The first are for people that want to specify by purpose,
the second one are for people who already know exactly what
‘R4’ means.
-
Standard3¶
Standard instances, 3rd generation
-
Standard4¶
Standard instances, 4th generation
-
Standard5¶
Standard instances, 5th generation
-
Memory3¶
Memory optimized instances, 3rd generation
-
Memory4¶
Memory optimized instances, 3rd generation
-
Compute3¶
Compute optimized instances, 3rd generation
-
Compute4¶
Compute optimized instances, 4th generation
-
Compute5¶
Compute optimized instances, 5th generation
-
Storage2¶
Storage-optimized instances, 2nd generation
-
StorageCompute1¶
Storage/compute balanced instances, 1st generation
-
Io3¶
I/O-optimized instances, 3rd generation
-
Burstable2¶
Burstable instances, 2nd generation
-
Burstable3¶
Burstable instances, 3rd generation
-
MemoryIntensive1¶
Memory-intensive instances, 1st generation
-
MemoryIntensive1Extended¶
Memory-intensive instances, extended, 1st generation
-
Fpga1¶
Instances with customizable hardware acceleration, 1st generation
-
Graphics3¶
Graphics-optimized instances, 3rd generation
-
Parallel2¶
Parallel-processing optimized instances, 2nd generation
-
Parallel3¶
Parallel-processing optimized instances, 3nd generation
-
InstanceSize (enum)¶
-
class
@aws-cdk/aws-ec2.InstanceSize¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.InstanceSize;
const { InstanceSize } = require('@aws-cdk/aws-ec2');
import { InstanceSize } from '@aws-cdk/aws-ec2';
What size of instance to use
-
None¶
-
Micro¶
-
Small¶
-
Medium¶
-
Large¶
-
XLarge¶
-
XLarge2¶
-
XLarge4¶
-
XLarge8¶
-
XLarge9¶
-
XLarge10¶
-
XLarge12¶
-
XLarge16¶
-
XLarge18¶
-
XLarge24¶
-
XLarge32¶
-
InstanceType¶
-
class
@aws-cdk/aws-ec2.InstanceType(instanceTypeIdentifier)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.InstanceType;
const { InstanceType } = require('@aws-cdk/aws-ec2');
import { InstanceType } from '@aws-cdk/aws-ec2';
Instance type for EC2 instances
This class takes a literal string, good if you already
know the identifier of the type you want.
Parameters: instanceTypeIdentifier (string) – -
toString() → string¶ Return the instance type as a dotted string
Return type: string
-
instanceTypeIdentifier¶ Type: string (readonly)
-
InstanceTypePair¶
-
class
@aws-cdk/aws-ec2.InstanceTypePair(instanceClass, instanceSize)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.InstanceTypePair;
const { InstanceTypePair } = require('@aws-cdk/aws-ec2');
import { InstanceTypePair } from '@aws-cdk/aws-ec2';
Instance type for EC2 instances
This class takes a combination of a class and size.
Be aware that not all combinations of class and size are available, and not all
classes are available in all regions.
Extends: Parameters: - instanceClass (
InstanceClass) – - instanceSize (
InstanceSize) –
-
instanceClass¶ Type: InstanceClass(readonly)
-
instanceSize¶ Type: InstanceSize(readonly)
-
toString() → string¶ Inherited from
@aws-cdk/aws-ec2.InstanceTypeReturn the instance type as a dotted string
Return type: string
-
instanceTypeIdentifier¶ Inherited from
@aws-cdk/aws-ec2.InstanceTypeType: string (readonly)
- instanceClass (
LinuxOS¶
-
class
@aws-cdk/aws-ec2.LinuxOS¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.LinuxOS;
const { LinuxOS } = require('@aws-cdk/aws-ec2');
import { LinuxOS } from '@aws-cdk/aws-ec2';
OS features specialized for Linux
Extends: OperatingSystem-
createUserData(scripts) → string¶ Implements
@aws-cdk/aws-ec2.OperatingSystem.createUserData()Parameters: scripts (string[]) – Return type: string
-
type¶ Implements
@aws-cdk/aws-ec2.OperatingSystem.type()Type: OperatingSystemType(readonly)
-
MachineImage¶
-
class
@aws-cdk/aws-ec2.MachineImage(imageId, os)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.MachineImage;
const { MachineImage } = require('@aws-cdk/aws-ec2');
import { MachineImage } from '@aws-cdk/aws-ec2';
Representation of a machine to be launched
Combines an AMI ID with an OS.
Parameters: - imageId (string) –
- os (
OperatingSystem) –
-
imageId¶ Type: string (readonly)
-
os¶ Type: OperatingSystem(readonly)
NetworkInterfaceSecondaryPrivateIpAddresses¶
-
class
@aws-cdk/aws-ec2.NetworkInterfaceSecondaryPrivateIpAddresses([valueOrFunction[, displayName]])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.NetworkInterfaceSecondaryPrivateIpAddresses;
const { NetworkInterfaceSecondaryPrivateIpAddresses } = require('@aws-cdk/aws-ec2');
import { NetworkInterfaceSecondaryPrivateIpAddresses } from '@aws-cdk/aws-ec2';
Extends: Parameters: - valueOrFunction (any (optional)) – What this token will evaluate to, literal or function.
- displayName (string (optional)) – A human-readable display hint for this Token
-
concat(left, right) → @aws-cdk/cdk.Token¶ Inherited from
@aws-cdk/cdk.TokenReturn a concated version of this Token in a string context
The default implementation of this combines strings, but specialized
implements of Token can return a more appropriate value.
Parameters: - left (any) –
- right (any) –
Return type:
-
resolve() → any¶ Inherited from
@aws-cdk/cdk.TokenReturns: The resolved value for this token. Return type: any
-
toJSON() → any¶ Inherited from
@aws-cdk/cdk.TokenTurn this Token into JSON
This gets called by JSON.stringify(). We want to prohibit this, because
it’s not possible to do this properly, so we just throw an error here.
Return type: any
-
toList() → string[]¶ Inherited from
@aws-cdk/cdk.TokenReturn a string list representation of this token
Call this if the Token intrinsically evaluates to a list of strings.
If so, you can represent the Token in a similar way in the type
system.
Note that even though the Token is represented as a list of strings, you
still cannot do any operations on it such as concatenation, indexing,
or taking its length. The only useful operations you can do to these lists
is constructing a FnJoin or a FnSelect on it.
Return type: string[]
-
toString() → string¶ Inherited from
@aws-cdk/cdk.TokenReturn a reversible string representation of this token
If the Token is initialized with a literal, the stringified value of the
literal is returned. Otherwise, a special quoted string representation
of the Token is returned that can be embedded into other strings.
Strings with quoted Tokens in them can be restored back into
complex values with the Tokens restored by calling resolve()
on the string.
Return type: string
-
displayName¶ Inherited from
@aws-cdk/cdk.TokenA human-readable display hint for this Token
Type: string (optional) (readonly)
-
valueOrFunction¶ Inherited from
@aws-cdk/cdk.TokenWhat this token will evaluate to, literal or function.
Type: any (optional) (readonly)
OperatingSystem¶
-
class
@aws-cdk/aws-ec2.OperatingSystem¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.OperatingSystem;
const { OperatingSystem } = require('@aws-cdk/aws-ec2');
import { OperatingSystem } from '@aws-cdk/aws-ec2';
Abstraction of OS features we need to be aware of
Abstract: Yes -
createUserData(scripts) → string¶ Parameters: scripts (string[]) – Return type: string Abstract: Yes
-
type¶ Type: OperatingSystemType(readonly) (abstract)
-
OperatingSystemType (enum)¶
-
class
@aws-cdk/aws-ec2.OperatingSystemType¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.OperatingSystemType;
const { OperatingSystemType } = require('@aws-cdk/aws-ec2');
import { OperatingSystemType } from '@aws-cdk/aws-ec2';
The OS type of a particular image
-
Linux¶
-
Windows¶
-
PrefixList¶
-
class
@aws-cdk/aws-ec2.PrefixList(prefixListId)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.PrefixList;
const { PrefixList } = require('@aws-cdk/aws-ec2');
import { PrefixList } from '@aws-cdk/aws-ec2';
A prefix list
Prefix lists are used to allow traffic to VPC-local service endpoints.
For more information, see this page:
https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-endpoints.html
Implements: ISecurityGroupRuleImplements: IConnectableParameters: prefixListId (string) – -
toEgressRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.toEgressRuleJSON()Produce the egress rule JSON for the given connection
Return type: any
-
toIngressRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.toIngressRuleJSON()Produce the ingress rule JSON for the given connection
Return type: any
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.canInlineRule()Whether the rule can be inlined into a SecurityGroup or not
Type: boolean (readonly)
-
connections¶ Implements
@aws-cdk/aws-ec2.IConnectable.connections()Type: Connections(readonly)
-
prefixListId¶ Type: string (readonly)
-
uniqueId¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.uniqueId()A unique identifier for this connection peer
Type: string (readonly)
-
Protocol (enum)¶
SecurityGroup¶
-
class
@aws-cdk/aws-ec2.SecurityGroup(parent, name, props)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.SecurityGroup;
const { SecurityGroup } = require('@aws-cdk/aws-ec2');
import { SecurityGroup } from '@aws-cdk/aws-ec2';
Creates an Amazon EC2 security group within a VPC.
This class has an additional optimization over SecurityGroupRef that it can also create
inline ingress and egress rule (which saves on the total number of resources inside
the template).
Extends: Implements: Parameters: - parent (
@aws-cdk/cdk.Construct) – - name (string) –
- props (
SecurityGroupProps) –
-
addEgressRule(peer, connection[, description])¶ Overrides
@aws-cdk/aws-ec2.SecurityGroupRef.addEgressRule()Parameters: - peer (
ISecurityGroupRule) – - connection (
IPortRange) – - description (string (optional)) –
- peer (
-
addIngressRule(peer, connection[, description])¶ Overrides
@aws-cdk/aws-ec2.SecurityGroupRef.addIngressRule()Parameters: - peer (
ISecurityGroupRule) – - connection (
IPortRange) – - description (string (optional)) –
- peer (
-
groupName¶ An attribute that represents the security group name.
Type: string (readonly)
-
securityGroupId¶ Implements
@aws-cdk/aws-ec2.SecurityGroupRef.securityGroupId()The ID of the security group
Type: string (readonly)
Implements
@aws-cdk/cdk.ITaggable.tags()Manage tags for this construct and children
Type: @aws-cdk/cdk.TagManager(readonly)
-
vpcId¶ An attribute that represents the physical VPC ID this security group is part of.
Type: string (readonly)
-
export() → @aws-cdk/aws-ec2.SecurityGroupRefProps¶ Inherited from
@aws-cdk/aws-ec2.SecurityGroupRefExport this SecurityGroup for use in a different Stack
Return type: SecurityGroupRefProps
-
toEgressRuleJSON() → any¶ Inherited from
@aws-cdk/aws-ec2.SecurityGroupRefProduce the egress rule JSON for the given connection
Return type: any
-
toIngressRuleJSON() → any¶ Inherited from
@aws-cdk/aws-ec2.SecurityGroupRefProduce the ingress rule JSON for the given connection
Return type: any
-
canInlineRule¶ Inherited from
@aws-cdk/aws-ec2.SecurityGroupRefWhether the rule can be inlined into a SecurityGroup or not
Type: boolean (readonly)
-
connections¶ Inherited from
@aws-cdk/aws-ec2.SecurityGroupRefType: Connections(readonly)
-
defaultPortRange¶ Inherited from
@aws-cdk/aws-ec2.SecurityGroupRefFIXME: Where to place this??
Type: IPortRange(optional) (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
- parent (
SecurityGroupProps (interface)¶
-
class
@aws-cdk/aws-ec2.SecurityGroupProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.SecurityGroupProps;
// SecurityGroupProps is an interfaceimport { SecurityGroupProps } from '@aws-cdk/aws-ec2';
-
vpc¶ The VPC in which to create the security group.
Type: VpcNetworkRef
-
allowAllOutbound¶ Whether to allow all outbound traffic by default.
If this is set to true, there will only be a single egress rule which allows all
outbound traffic. If this is set to false, no outbound traffic will be allowed by
default and all egress traffic must be explicitly authorized.
Type: boolean (optional) Default: true
-
description¶ A description of the security group.
Type: string (optional) Default: The default name will be the construct’s CDK path.
-
groupName¶ The name of the security group. For valid values, see the GroupName
parameter of the CreateSecurityGroup action in the Amazon EC2 API
Reference.
It is not recommended to use an explicit group name.
Type: string (optional) Default: If you don’t specify a GroupName, AWS CloudFormation generates a
-
unique physical ID and uses that ID for the group name.
The AWS resource tags to associate with the security group.
Type: string => string (optional)
SecurityGroupRef¶
-
class
@aws-cdk/aws-ec2.SecurityGroupRef(parent, id)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.SecurityGroupRef;
const { SecurityGroupRef } = require('@aws-cdk/aws-ec2');
import { SecurityGroupRef } from '@aws-cdk/aws-ec2';
A SecurityGroup that is not created in this template
Extends: Implements: Implements: Abstract: Yes
Parameters: - parent (
@aws-cdk/cdk.Construct) – The parent construct - id (string) –
-
static
import(parent, id, props) → @aws-cdk/aws-ec2.SecurityGroupRef¶ Import an existing SecurityGroup
Parameters: - parent (
@aws-cdk/cdk.Construct) – - id (string) –
- props (
SecurityGroupRefProps) –
Return type: - parent (
-
addEgressRule(peer, connection[, description])¶ Parameters: - peer (
ISecurityGroupRule) – - connection (
IPortRange) – - description (string (optional)) –
- peer (
-
addIngressRule(peer, connection[, description])¶ Parameters: - peer (
ISecurityGroupRule) – - connection (
IPortRange) – - description (string (optional)) –
- peer (
-
export() → @aws-cdk/aws-ec2.SecurityGroupRefProps¶ Export this SecurityGroup for use in a different Stack
Return type: SecurityGroupRefProps
-
toEgressRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.toEgressRuleJSON()Produce the egress rule JSON for the given connection
Return type: any
-
toIngressRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.toIngressRuleJSON()Produce the ingress rule JSON for the given connection
Return type: any
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.ISecurityGroupRule.canInlineRule()Whether the rule can be inlined into a SecurityGroup or not
Type: boolean (readonly)
-
connections¶ Implements
@aws-cdk/aws-ec2.IConnectable.connections()Type: Connections(readonly)
-
securityGroupId¶ Type: string (readonly) (abstract)
-
defaultPortRange¶ FIXME: Where to place this??
Type: IPortRange(optional) (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
- parent (
SecurityGroupRefProps (interface)¶
-
class
@aws-cdk/aws-ec2.SecurityGroupRefProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.SecurityGroupRefProps;
// SecurityGroupRefProps is an interfaceimport { SecurityGroupRefProps } from '@aws-cdk/aws-ec2';
-
securityGroupId¶ ID of security group
Type: string
-
SubnetConfiguration (interface)¶
-
class
@aws-cdk/aws-ec2.SubnetConfiguration¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.SubnetConfiguration;
// SubnetConfiguration is an interfaceimport { SubnetConfiguration } from '@aws-cdk/aws-ec2';
Specify configuration parameters for a VPC to be built
-
name¶ The common Logical Name for the VpcSubnet
Thi name will be suffixed with an integer correlating to a specific
availability zone.
Type: string
-
subnetType¶ The type of Subnet to configure.
The Subnet type will control the ability to route and connect to the
Internet.
Type: SubnetType
-
cidrMask¶ The CIDR Mask or the number of leading 1 bits in the routing mask
Valid values are 16 - 28
Type: number (optional)
The AWS resource tags to associate with the resource.
Type: string => string (optional)
-
SubnetIpv6CidrBlocks¶
-
class
@aws-cdk/aws-ec2.SubnetIpv6CidrBlocks([valueOrFunction[, displayName]])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.SubnetIpv6CidrBlocks;
const { SubnetIpv6CidrBlocks } = require('@aws-cdk/aws-ec2');
import { SubnetIpv6CidrBlocks } from '@aws-cdk/aws-ec2';
Extends: Parameters: - valueOrFunction (any (optional)) – What this token will evaluate to, literal or function.
- displayName (string (optional)) – A human-readable display hint for this Token
-
concat(left, right) → @aws-cdk/cdk.Token¶ Inherited from
@aws-cdk/cdk.TokenReturn a concated version of this Token in a string context
The default implementation of this combines strings, but specialized
implements of Token can return a more appropriate value.
Parameters: - left (any) –
- right (any) –
Return type:
-
resolve() → any¶ Inherited from
@aws-cdk/cdk.TokenReturns: The resolved value for this token. Return type: any
-
toJSON() → any¶ Inherited from
@aws-cdk/cdk.TokenTurn this Token into JSON
This gets called by JSON.stringify(). We want to prohibit this, because
it’s not possible to do this properly, so we just throw an error here.
Return type: any
-
toList() → string[]¶ Inherited from
@aws-cdk/cdk.TokenReturn a string list representation of this token
Call this if the Token intrinsically evaluates to a list of strings.
If so, you can represent the Token in a similar way in the type
system.
Note that even though the Token is represented as a list of strings, you
still cannot do any operations on it such as concatenation, indexing,
or taking its length. The only useful operations you can do to these lists
is constructing a FnJoin or a FnSelect on it.
Return type: string[]
-
toString() → string¶ Inherited from
@aws-cdk/cdk.TokenReturn a reversible string representation of this token
If the Token is initialized with a literal, the stringified value of the
literal is returned. Otherwise, a special quoted string representation
of the Token is returned that can be embedded into other strings.
Strings with quoted Tokens in them can be restored back into
complex values with the Tokens restored by calling resolve()
on the string.
Return type: string
-
displayName¶ Inherited from
@aws-cdk/cdk.TokenA human-readable display hint for this Token
Type: string (optional) (readonly)
-
valueOrFunction¶ Inherited from
@aws-cdk/cdk.TokenWhat this token will evaluate to, literal or function.
Type: any (optional) (readonly)
SubnetType (enum)¶
-
class
@aws-cdk/aws-ec2.SubnetType¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.SubnetType;
const { SubnetType } = require('@aws-cdk/aws-ec2');
import { SubnetType } from '@aws-cdk/aws-ec2';
The type of Subnet
-
Isolated¶
Isolated Subnets do not route Outbound traffic
This can be good for subnets with RDS or
Elasticache endpoints
-
Private¶
Subnet that routes to the internet, but not vice versa.
Instances in a private subnet can connect to the Internet, but will not
allow connections to be initiated from the Internet.
Outbound traffic will be routed via a NAT Gateway. Preference being in
the same AZ, but if not available will use another AZ (control by
specifing maxGateways on VpcNetwork). This might be used for
experimental cost conscious accounts or accounts where HA outbound
traffic is not needed.
-
Public¶
Subnet connected to the Internet
Instances in a Public subnet can connect to the Internet and can be
connected to from the Internet as long as they are launched with public
IPs (controlled on the AutoScalingGroup or other constructs that launch
instances).
Public subnets route outbound traffic via an Internet Gateway.
-
TcpAllPorts¶
-
class
@aws-cdk/aws-ec2.TcpAllPorts¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.TcpAllPorts;
const { TcpAllPorts } = require('@aws-cdk/aws-ec2');
import { TcpAllPorts } from '@aws-cdk/aws-ec2';
All TCP Ports
Implements: IPortRange-
toRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.IPortRange.toRuleJSON()Produce the ingress/egress rule JSON for the given connection
Return type: any
-
toString() → string¶ Returns a string representation of an object.
Return type: string
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.IPortRange.canInlineRule()Whether the rule containing this port range can be inlined into a securitygroup or not.
Type: boolean (readonly)
-
TcpPort¶
-
class
@aws-cdk/aws-ec2.TcpPort(port)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.TcpPort;
const { TcpPort } = require('@aws-cdk/aws-ec2');
import { TcpPort } from '@aws-cdk/aws-ec2';
A single TCP port
Implements: IPortRangeParameters: port (number) – -
toRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.IPortRange.toRuleJSON()Produce the ingress/egress rule JSON for the given connection
Return type: any
-
toString() → string¶ Returns a string representation of an object.
Return type: string
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.IPortRange.canInlineRule()Whether the rule containing this port range can be inlined into a securitygroup or not.
Type: boolean (readonly)
-
port¶ Type: number (readonly)
-
TcpPortFromAttribute¶
-
class
@aws-cdk/aws-ec2.TcpPortFromAttribute(port)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.TcpPortFromAttribute;
const { TcpPortFromAttribute } = require('@aws-cdk/aws-ec2');
import { TcpPortFromAttribute } from '@aws-cdk/aws-ec2';
A single TCP port that is provided by a resource attribute
Implements: IPortRangeParameters: port (string) – -
toRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.IPortRange.toRuleJSON()Produce the ingress/egress rule JSON for the given connection
Return type: any
-
toString() → string¶ Returns a string representation of an object.
Return type: string
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.IPortRange.canInlineRule()Whether the rule containing this port range can be inlined into a securitygroup or not.
Type: boolean (readonly)
-
port¶ Type: string (readonly)
-
TcpPortRange¶
-
class
@aws-cdk/aws-ec2.TcpPortRange(startPort, endPort)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.TcpPortRange;
const { TcpPortRange } = require('@aws-cdk/aws-ec2');
import { TcpPortRange } from '@aws-cdk/aws-ec2';
A TCP port range
Implements: Parameters: - startPort (number) –
- endPort (number) –
-
toRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.IPortRange.toRuleJSON()Produce the ingress/egress rule JSON for the given connection
Return type: any
-
toString() → string¶ Returns a string representation of an object.
Return type: string
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.IPortRange.canInlineRule()Whether the rule containing this port range can be inlined into a securitygroup or not.
Type: boolean (readonly)
-
endPort¶ Type: number (readonly)
-
startPort¶ Type: number (readonly)
UdpAllPorts¶
-
class
@aws-cdk/aws-ec2.UdpAllPorts¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.UdpAllPorts;
const { UdpAllPorts } = require('@aws-cdk/aws-ec2');
import { UdpAllPorts } from '@aws-cdk/aws-ec2';
All UDP Ports
Implements: IPortRange-
toRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.IPortRange.toRuleJSON()Produce the ingress/egress rule JSON for the given connection
Return type: any
-
toString() → string¶ Returns a string representation of an object.
Return type: string
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.IPortRange.canInlineRule()Whether the rule containing this port range can be inlined into a securitygroup or not.
Type: boolean (readonly)
-
UdpPort¶
-
class
@aws-cdk/aws-ec2.UdpPort(port)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.UdpPort;
const { UdpPort } = require('@aws-cdk/aws-ec2');
import { UdpPort } from '@aws-cdk/aws-ec2';
A single UDP port
Implements: IPortRangeParameters: port (number) – -
toRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.IPortRange.toRuleJSON()Produce the ingress/egress rule JSON for the given connection
Return type: any
-
toString() → string¶ Returns a string representation of an object.
Return type: string
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.IPortRange.canInlineRule()Whether the rule containing this port range can be inlined into a securitygroup or not.
Type: boolean (readonly)
-
port¶ Type: number (readonly)
-
UdpPortFromAttribute¶
-
class
@aws-cdk/aws-ec2.UdpPortFromAttribute(port)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.UdpPortFromAttribute;
const { UdpPortFromAttribute } = require('@aws-cdk/aws-ec2');
import { UdpPortFromAttribute } from '@aws-cdk/aws-ec2';
A single UDP port that is provided by a resource attribute
Implements: IPortRangeParameters: port (string) – -
toRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.IPortRange.toRuleJSON()Produce the ingress/egress rule JSON for the given connection
Return type: any
-
toString() → string¶ Returns a string representation of an object.
Return type: string
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.IPortRange.canInlineRule()Whether the rule containing this port range can be inlined into a securitygroup or not.
Type: boolean (readonly)
-
port¶ Type: string (readonly)
-
UdpPortRange¶
-
class
@aws-cdk/aws-ec2.UdpPortRange(startPort, endPort)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.UdpPortRange;
const { UdpPortRange } = require('@aws-cdk/aws-ec2');
import { UdpPortRange } from '@aws-cdk/aws-ec2';
A UDP port range
Implements: Parameters: - startPort (number) –
- endPort (number) –
-
toRuleJSON() → any¶ Implements
@aws-cdk/aws-ec2.IPortRange.toRuleJSON()Produce the ingress/egress rule JSON for the given connection
Return type: any
-
toString() → string¶ Returns a string representation of an object.
Return type: string
-
canInlineRule¶ Implements
@aws-cdk/aws-ec2.IPortRange.canInlineRule()Whether the rule containing this port range can be inlined into a securitygroup or not.
Type: boolean (readonly)
-
endPort¶ Type: number (readonly)
-
startPort¶ Type: number (readonly)
VPCCidrBlockAssociations¶
-
class
@aws-cdk/aws-ec2.VPCCidrBlockAssociations([valueOrFunction[, displayName]])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VPCCidrBlockAssociations;
const { VPCCidrBlockAssociations } = require('@aws-cdk/aws-ec2');
import { VPCCidrBlockAssociations } from '@aws-cdk/aws-ec2';
Extends: Parameters: - valueOrFunction (any (optional)) – What this token will evaluate to, literal or function.
- displayName (string (optional)) – A human-readable display hint for this Token
-
concat(left, right) → @aws-cdk/cdk.Token¶ Inherited from
@aws-cdk/cdk.TokenReturn a concated version of this Token in a string context
The default implementation of this combines strings, but specialized
implements of Token can return a more appropriate value.
Parameters: - left (any) –
- right (any) –
Return type:
-
resolve() → any¶ Inherited from
@aws-cdk/cdk.TokenReturns: The resolved value for this token. Return type: any
-
toJSON() → any¶ Inherited from
@aws-cdk/cdk.TokenTurn this Token into JSON
This gets called by JSON.stringify(). We want to prohibit this, because
it’s not possible to do this properly, so we just throw an error here.
Return type: any
-
toList() → string[]¶ Inherited from
@aws-cdk/cdk.TokenReturn a string list representation of this token
Call this if the Token intrinsically evaluates to a list of strings.
If so, you can represent the Token in a similar way in the type
system.
Note that even though the Token is represented as a list of strings, you
still cannot do any operations on it such as concatenation, indexing,
or taking its length. The only useful operations you can do to these lists
is constructing a FnJoin or a FnSelect on it.
Return type: string[]
-
toString() → string¶ Inherited from
@aws-cdk/cdk.TokenReturn a reversible string representation of this token
If the Token is initialized with a literal, the stringified value of the
literal is returned. Otherwise, a special quoted string representation
of the Token is returned that can be embedded into other strings.
Strings with quoted Tokens in them can be restored back into
complex values with the Tokens restored by calling resolve()
on the string.
Return type: string
-
displayName¶ Inherited from
@aws-cdk/cdk.TokenA human-readable display hint for this Token
Type: string (optional) (readonly)
-
valueOrFunction¶ Inherited from
@aws-cdk/cdk.TokenWhat this token will evaluate to, literal or function.
Type: any (optional) (readonly)
VPCEndpointDnsEntries¶
-
class
@aws-cdk/aws-ec2.VPCEndpointDnsEntries([valueOrFunction[, displayName]])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VPCEndpointDnsEntries;
const { VPCEndpointDnsEntries } = require('@aws-cdk/aws-ec2');
import { VPCEndpointDnsEntries } from '@aws-cdk/aws-ec2';
Extends: Parameters: - valueOrFunction (any (optional)) – What this token will evaluate to, literal or function.
- displayName (string (optional)) – A human-readable display hint for this Token
-
concat(left, right) → @aws-cdk/cdk.Token¶ Inherited from
@aws-cdk/cdk.TokenReturn a concated version of this Token in a string context
The default implementation of this combines strings, but specialized
implements of Token can return a more appropriate value.
Parameters: - left (any) –
- right (any) –
Return type:
-
resolve() → any¶ Inherited from
@aws-cdk/cdk.TokenReturns: The resolved value for this token. Return type: any
-
toJSON() → any¶ Inherited from
@aws-cdk/cdk.TokenTurn this Token into JSON
This gets called by JSON.stringify(). We want to prohibit this, because
it’s not possible to do this properly, so we just throw an error here.
Return type: any
-
toList() → string[]¶ Inherited from
@aws-cdk/cdk.TokenReturn a string list representation of this token
Call this if the Token intrinsically evaluates to a list of strings.
If so, you can represent the Token in a similar way in the type
system.
Note that even though the Token is represented as a list of strings, you
still cannot do any operations on it such as concatenation, indexing,
or taking its length. The only useful operations you can do to these lists
is constructing a FnJoin or a FnSelect on it.
Return type: string[]
-
toString() → string¶ Inherited from
@aws-cdk/cdk.TokenReturn a reversible string representation of this token
If the Token is initialized with a literal, the stringified value of the
literal is returned. Otherwise, a special quoted string representation
of the Token is returned that can be embedded into other strings.
Strings with quoted Tokens in them can be restored back into
complex values with the Tokens restored by calling resolve()
on the string.
Return type: string
-
displayName¶ Inherited from
@aws-cdk/cdk.TokenA human-readable display hint for this Token
Type: string (optional) (readonly)
-
valueOrFunction¶ Inherited from
@aws-cdk/cdk.TokenWhat this token will evaluate to, literal or function.
Type: any (optional) (readonly)
VPCEndpointNetworkInterfaceIds¶
-
class
@aws-cdk/aws-ec2.VPCEndpointNetworkInterfaceIds([valueOrFunction[, displayName]])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VPCEndpointNetworkInterfaceIds;
const { VPCEndpointNetworkInterfaceIds } = require('@aws-cdk/aws-ec2');
import { VPCEndpointNetworkInterfaceIds } from '@aws-cdk/aws-ec2';
Extends: Parameters: - valueOrFunction (any (optional)) – What this token will evaluate to, literal or function.
- displayName (string (optional)) – A human-readable display hint for this Token
-
concat(left, right) → @aws-cdk/cdk.Token¶ Inherited from
@aws-cdk/cdk.TokenReturn a concated version of this Token in a string context
The default implementation of this combines strings, but specialized
implements of Token can return a more appropriate value.
Parameters: - left (any) –
- right (any) –
Return type:
-
resolve() → any¶ Inherited from
@aws-cdk/cdk.TokenReturns: The resolved value for this token. Return type: any
-
toJSON() → any¶ Inherited from
@aws-cdk/cdk.TokenTurn this Token into JSON
This gets called by JSON.stringify(). We want to prohibit this, because
it’s not possible to do this properly, so we just throw an error here.
Return type: any
-
toList() → string[]¶ Inherited from
@aws-cdk/cdk.TokenReturn a string list representation of this token
Call this if the Token intrinsically evaluates to a list of strings.
If so, you can represent the Token in a similar way in the type
system.
Note that even though the Token is represented as a list of strings, you
still cannot do any operations on it such as concatenation, indexing,
or taking its length. The only useful operations you can do to these lists
is constructing a FnJoin or a FnSelect on it.
Return type: string[]
-
toString() → string¶ Inherited from
@aws-cdk/cdk.TokenReturn a reversible string representation of this token
If the Token is initialized with a literal, the stringified value of the
literal is returned. Otherwise, a special quoted string representation
of the Token is returned that can be embedded into other strings.
Strings with quoted Tokens in them can be restored back into
complex values with the Tokens restored by calling resolve()
on the string.
Return type: string
-
displayName¶ Inherited from
@aws-cdk/cdk.TokenA human-readable display hint for this Token
Type: string (optional) (readonly)
-
valueOrFunction¶ Inherited from
@aws-cdk/cdk.TokenWhat this token will evaluate to, literal or function.
Type: any (optional) (readonly)
VPCIpv6CidrBlocks¶
-
class
@aws-cdk/aws-ec2.VPCIpv6CidrBlocks([valueOrFunction[, displayName]])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VPCIpv6CidrBlocks;
const { VPCIpv6CidrBlocks } = require('@aws-cdk/aws-ec2');
import { VPCIpv6CidrBlocks } from '@aws-cdk/aws-ec2';
Extends: Parameters: - valueOrFunction (any (optional)) – What this token will evaluate to, literal or function.
- displayName (string (optional)) – A human-readable display hint for this Token
-
concat(left, right) → @aws-cdk/cdk.Token¶ Inherited from
@aws-cdk/cdk.TokenReturn a concated version of this Token in a string context
The default implementation of this combines strings, but specialized
implements of Token can return a more appropriate value.
Parameters: - left (any) –
- right (any) –
Return type:
-
resolve() → any¶ Inherited from
@aws-cdk/cdk.TokenReturns: The resolved value for this token. Return type: any
-
toJSON() → any¶ Inherited from
@aws-cdk/cdk.TokenTurn this Token into JSON
This gets called by JSON.stringify(). We want to prohibit this, because
it’s not possible to do this properly, so we just throw an error here.
Return type: any
-
toList() → string[]¶ Inherited from
@aws-cdk/cdk.TokenReturn a string list representation of this token
Call this if the Token intrinsically evaluates to a list of strings.
If so, you can represent the Token in a similar way in the type
system.
Note that even though the Token is represented as a list of strings, you
still cannot do any operations on it such as concatenation, indexing,
or taking its length. The only useful operations you can do to these lists
is constructing a FnJoin or a FnSelect on it.
Return type: string[]
-
toString() → string¶ Inherited from
@aws-cdk/cdk.TokenReturn a reversible string representation of this token
If the Token is initialized with a literal, the stringified value of the
literal is returned. Otherwise, a special quoted string representation
of the Token is returned that can be embedded into other strings.
Strings with quoted Tokens in them can be restored back into
complex values with the Tokens restored by calling resolve()
on the string.
Return type: string
-
displayName¶ Inherited from
@aws-cdk/cdk.TokenA human-readable display hint for this Token
Type: string (optional) (readonly)
-
valueOrFunction¶ Inherited from
@aws-cdk/cdk.TokenWhat this token will evaluate to, literal or function.
Type: any (optional) (readonly)
VpcNetwork¶
-
class
@aws-cdk/aws-ec2.VpcNetwork(parent, name[, props])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcNetwork;
const { VpcNetwork } = require('@aws-cdk/aws-ec2');
import { VpcNetwork } from '@aws-cdk/aws-ec2';
VpcNetwork deploys an AWS VPC, with public and private subnets per Availability Zone.
For example:
import { VpcNetwork } from ‘@aws-cdk/aws-ec2’
const vpc = new VpcNetwork(this, {
cidr: “10.0.0.0/16”})
// Iterate the public subnets
for (let subnet of vpc.publicSubnets) {
}
// Iterate the private subnets
for (let subnet of vpc.privateSubnets) {
}
Extends: Implements: Parameters: - parent (
@aws-cdk/cdk.Construct) – - name (string) –
- props (
VpcNetworkProps(optional)) –
-
DEFAULT_CIDR_RANGE¶ The default CIDR range used when creating VPCs.
This can be overridden using VpcNetworkProps when creating a VPCNetwork resource.
e.g. new VpcResource(this, { cidr: ‘192.168.0.0./16’ })
Type: string (readonly) (static)
-
DEFAULT_SUBNETS¶ The default subnet configuration
1 Public and 1 Private subnet per AZ evenly split
Type: SubnetConfiguration[] (readonly) (static)
-
availabilityZones¶ Implements
@aws-cdk/aws-ec2.VpcNetworkRef.availabilityZones()AZs for this VPC
Type: string[] (readonly)
-
cidr¶ Type: string (readonly)
-
isolatedSubnets¶ Implements
@aws-cdk/aws-ec2.VpcNetworkRef.isolatedSubnets()List of isolated subnets in this VPC
Type: VpcSubnetRef[] (readonly)
-
privateSubnets¶ Implements
@aws-cdk/aws-ec2.VpcNetworkRef.privateSubnets()List of private subnets in this VPC
Type: VpcSubnetRef[] (readonly)
-
publicSubnets¶ Implements
@aws-cdk/aws-ec2.VpcNetworkRef.publicSubnets()List of public subnets in this VPC
Type: VpcSubnetRef[] (readonly)
Implements
@aws-cdk/cdk.ITaggable.tags()Manage tags for this construct and children
Type: @aws-cdk/cdk.TagManager(readonly)
-
vpcId¶ Implements
@aws-cdk/aws-ec2.VpcNetworkRef.vpcId()Identifier for this VPC
Type: string (readonly)
-
export() → @aws-cdk/aws-ec2.VpcNetworkRefProps¶ Inherited from
@aws-cdk/aws-ec2.VpcNetworkRefExport this VPC from the stack
Return type: VpcNetworkRefProps
-
isPublicSubnet(subnet) → boolean¶ Inherited from
@aws-cdk/aws-ec2.VpcNetworkRefReturn whether the given subnet is one of this VPC’s public subnets.
The subnet must literally be one of the subnet object obtained from
this VPC. A subnet that merely represents the same subnet will
never return true.
Parameters: subnet ( VpcSubnetRef) –Return type: boolean
-
subnets([placement]) → @aws-cdk/aws-ec2.VpcSubnetRef[]¶ Inherited from
@aws-cdk/aws-ec2.VpcNetworkRefReturn the subnets appropriate for the placement strategy
Parameters: placement ( VpcPlacementStrategy(optional)) –Return type: VpcSubnetRef[]
-
dependencyElements¶ Inherited from
@aws-cdk/aws-ec2.VpcNetworkRefParts of the VPC that constitute full construction
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
- parent (
VpcNetworkProps (interface)¶
-
class
@aws-cdk/aws-ec2.VpcNetworkProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcNetworkProps;
// VpcNetworkProps is an interfaceimport { VpcNetworkProps } from '@aws-cdk/aws-ec2';
VpcNetworkProps allows you to specify configuration options for a VPC
-
cidr¶ The CIDR range to use for the VPC (e.g. ‘10.0.0.0/16’). Should be a minimum of /28 and maximum size of /16.
The range will be split evenly into two subnets per Availability Zone (one public, one private).
Type: string (optional)
-
defaultInstanceTenancy¶ The default tenancy of instances launched into the VPC.
By default, instances will be launched with default (shared) tenancy.
By setting this to dedicated tenancy, instances will be launched on hardware dedicated
to a single AWS customer, unless specifically specified at instance launch time.
Please note, not all instance types are usable with Dedicated tenancy.
Type: DefaultInstanceTenancy(optional)
-
enableDnsHostnames¶ Indicates whether the instances launched in the VPC get public DNS hostnames.
If this attribute is true, instances in the VPC get public DNS hostnames,
but only if the enableDnsSupport attribute is also set to true.
Type: boolean (optional)
-
enableDnsSupport¶ Indicates whether the DNS resolution is supported for the VPC. If this attribute
is false, the Amazon-provided DNS server in the VPC that resolves public DNS hostnames
to IP addresses is not enabled. If this attribute is true, queries to the Amazon
provided DNS server at the 169.254.169.253 IP address, or the reserved IP address
at the base of the VPC IPv4 network range plus two will succeed.
Type: boolean (optional)
-
maxAZs¶ Define the maximum number of AZs to use in this region
If the region has more AZs than you want to use (for example, because of EIP limits),
pick a lower number here. The AZs will be sorted and picked from the start of the list.
Type: number (optional) Default: All AZs in the region
-
natGatewayPlacement¶ Configures the subnets which will have NAT Gateways
You can pick a specific group of subnets by specifying the group name;
the picked subnets must be public subnets.
Type: VpcPlacementStrategy(optional)Default: All public subnets
-
natGateways¶ The number of NAT Gateways to create.
For example, if set this to 1 and your subnet configuration is for 3 Public subnets then only
one of the Public subnets will have a gateway and all Private subnets will route to this NAT Gateway.
Type: number (optional) Default: maxAZs
-
subnetConfiguration¶ Configure the subnets to build for each AZ
The subnets are constructed in the context of the VPC so you only need
specify the configuration. The VPC details (VPC ID, specific CIDR,
specific AZ will be calculated during creation)
For example if you want 1 public subnet, 1 private subnet, and 1 isolated
subnet in each AZ provide the following:
subnetConfiguration: [
{
cidrMask: 24,
name: ‘ingress’,
subnetType: SubnetType.Public,
},
{
cidrMask: 24,
name: ‘application’,
subnetType: SubnetType.Private,
},
{
cidrMask: 28,
name: ‘rds’,
subnetType: SubnetType.Isolated,
}
]
cidrMask is optional and if not provided the IP space in the VPC will be
evenly divided between the requested subnets.
Type: SubnetConfiguration[] (optional)Default: the VPC CIDR will be evenly divided between 1 public and 1
-
private subnet per AZ
@aws-cdk/aws-ec2.tagsThe AWS resource tags to associate with the VPC.
Type: string => string (optional)
VpcNetworkProvider¶
-
class
@aws-cdk/aws-ec2.VpcNetworkProvider(context, props)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcNetworkProvider;
const { VpcNetworkProvider } = require('@aws-cdk/aws-ec2');
import { VpcNetworkProvider } from '@aws-cdk/aws-ec2';
Context provider to discover and import existing VPCs
Parameters: - context (
@aws-cdk/cdk.Construct) – - props (
VpcNetworkProviderProps) –
-
vpcProps¶ Return the VPC import props matching the filter
Type: VpcNetworkRefProps(readonly)
- context (
VpcNetworkProviderProps (interface)¶
-
class
@aws-cdk/aws-ec2.VpcNetworkProviderProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcNetworkProviderProps;
// VpcNetworkProviderProps is an interfaceimport { VpcNetworkProviderProps } from '@aws-cdk/aws-ec2';
Properties for looking up an existing VPC.
The combination of properties must specify filter down to exactly one
non-default VPC, otherwise an error is raised.
-
isDefault¶ Whether to match the default VPC
Type: boolean (optional) Default: Don’t care whether we return the default VPC
Tags on the VPC
The VPC must have all of these tags
Type: string => string (optional) Default: Don’t filter on tags
-
vpcId¶ The ID of the VPC
If given, will import exactly this VPC.
Type: string (optional) Default: Don’t filter on vpcId
-
vpcName¶ The name of the VPC
If given, will import the VPC with this name.
Type: string (optional) Default: Don’t filter on vpcName
-
VpcNetworkRef¶
-
class
@aws-cdk/aws-ec2.VpcNetworkRef(parent, id)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcNetworkRef;
const { VpcNetworkRef } = require('@aws-cdk/aws-ec2');
import { VpcNetworkRef } from '@aws-cdk/aws-ec2';
A new or imported VPC
Extends: Implements: Abstract: Yes
Parameters: - parent (
@aws-cdk/cdk.Construct) – The parent construct - id (string) –
-
static
import(parent, name, props) → @aws-cdk/aws-ec2.VpcNetworkRef¶ Import an exported VPC
Parameters: - parent (
@aws-cdk/cdk.Construct) – - name (string) –
- props (
VpcNetworkRefProps) –
Return type: - parent (
-
static
importFromContext(parent, name, props) → @aws-cdk/aws-ec2.VpcNetworkRef¶ Import an existing VPC from context
Parameters: - parent (
@aws-cdk/cdk.Construct) – - name (string) –
- props (
VpcNetworkProviderProps) –
Return type: - parent (
-
export() → @aws-cdk/aws-ec2.VpcNetworkRefProps¶ Export this VPC from the stack
Return type: VpcNetworkRefProps
-
isPublicSubnet(subnet) → boolean¶ Return whether the given subnet is one of this VPC’s public subnets.
The subnet must literally be one of the subnet object obtained from
this VPC. A subnet that merely represents the same subnet will
never return true.
Parameters: subnet ( VpcSubnetRef) –Return type: boolean
-
subnets([placement]) → @aws-cdk/aws-ec2.VpcSubnetRef[]¶ Return the subnets appropriate for the placement strategy
Parameters: placement ( VpcPlacementStrategy(optional)) –Return type: VpcSubnetRef[]
-
availabilityZones¶ AZs for this VPC
Type: string[] (readonly) (abstract)
-
dependencyElements¶ Implements
@aws-cdk/cdk.IDependable.dependencyElements()Parts of the VPC that constitute full construction
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
isolatedSubnets¶ List of isolated subnets in this VPC
Type: VpcSubnetRef[] (readonly) (abstract)
-
privateSubnets¶ List of private subnets in this VPC
Type: VpcSubnetRef[] (readonly) (abstract)
-
publicSubnets¶ List of public subnets in this VPC
Type: VpcSubnetRef[] (readonly) (abstract)
-
vpcId¶ Identifier for this VPC
Type: string (readonly) (abstract)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
- parent (
VpcNetworkRefProps (interface)¶
-
class
@aws-cdk/aws-ec2.VpcNetworkRefProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcNetworkRefProps;
// VpcNetworkRefProps is an interfaceimport { VpcNetworkRefProps } from '@aws-cdk/aws-ec2';
Properties that reference an external VpcNetwork
-
availabilityZones¶ List of availability zones for the subnets in this VPC.
Type: string[]
-
vpcId¶ VPC’s identifier
Type: string
-
isolatedSubnetIds¶ List of isolated subnet IDs
Must be undefined or match the availability zones in length and order.
Type: string[] (optional)
-
isolatedSubnetNames¶ List of names for the isolated subnets
Must be undefined or have a name for every isolated subnet group.
Type: string[] (optional)
-
privateSubnetIds¶ List of private subnet IDs
Must be undefined or match the availability zones in length and order.
Type: string[] (optional)
-
privateSubnetNames¶ List of names for the private subnets
Must be undefined or have a name for every private subnet group.
Type: string[] (optional)
-
publicSubnetIds¶ List of public subnet IDs
Must be undefined or match the availability zones in length and order.
Type: string[] (optional)
-
publicSubnetNames¶ List of names for the public subnets
Must be undefined or have a name for every public subnet group.
Type: string[] (optional)
-
VpcPlacementStrategy (interface)¶
-
class
@aws-cdk/aws-ec2.VpcPlacementStrategy¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcPlacementStrategy;
// VpcPlacementStrategy is an interfaceimport { VpcPlacementStrategy } from '@aws-cdk/aws-ec2';
Customize how instances are placed inside a VPC
Constructs that allow customization of VPC placement use parameters of this
type to provide placement settings.
By default, the instances are placed in the private subnets.
-
subnetName¶ Place the instances in the subnets with the given name
(This is the name supplied in subnetConfiguration).
At most one of subnetsToUse and subnetName can be supplied.
Type: string (optional) Default: name
-
subnetsToUse¶ Place the instances in the subnets of the given type
At most one of subnetsToUse and subnetName can be supplied.
Type: SubnetType(optional)Default: SubnetType.Private
-
VpcPrivateSubnet¶
-
class
@aws-cdk/aws-ec2.VpcPrivateSubnet(parent, name, props)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcPrivateSubnet;
const { VpcPrivateSubnet } = require('@aws-cdk/aws-ec2');
import { VpcPrivateSubnet } from '@aws-cdk/aws-ec2';
Represents a private VPC subnet resource
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – - name (string) –
- props (
VpcSubnetProps) –
-
addDefaultNatRouteEntry(natGatewayId)¶ Adds an entry to this subnets route table that points to the passed NATGatwayId
Parameters: natGatewayId (string) –
-
addDefaultRouteToIGW(gateway, gatewayAttachment)¶ Inherited from
@aws-cdk/aws-ec2.VpcSubnetCreate a default route that points to a passed IGW, with a dependency
on the IGW’s attachment to the VPC.
Protected method
Parameters: - gateway (
InternetGatewayResource) – - gatewayAttachment (
VPCGatewayAttachmentResource) –
- gateway (
-
addDefaultRouteToNAT(natGatewayId)¶ Inherited from
@aws-cdk/aws-ec2.VpcSubnetProtected method
Parameters: natGatewayId (string) –
-
availabilityZone¶ Inherited from
@aws-cdk/aws-ec2.VpcSubnetThe Availability Zone the subnet is located in
Type: string (readonly)
-
subnetId¶ Inherited from
@aws-cdk/aws-ec2.VpcSubnetThe subnetId for this particular subnet
Type: string (readonly)
Inherited from
@aws-cdk/aws-ec2.VpcSubnetManage tags for Construct and propagate to children
Type: @aws-cdk/cdk.TagManager(readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/aws-ec2.VpcSubnetRefParts of this VPC subnet
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
- parent (
VpcPublicSubnet¶
-
class
@aws-cdk/aws-ec2.VpcPublicSubnet(parent, name, props)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcPublicSubnet;
const { VpcPublicSubnet } = require('@aws-cdk/aws-ec2');
import { VpcPublicSubnet } from '@aws-cdk/aws-ec2';
Represents a public VPC subnet resource
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – - name (string) –
- props (
VpcSubnetProps) –
-
addDefaultIGWRouteEntry(gateway, gatewayAttachment)¶ Create a default route that points to a passed IGW, with a dependency
on the IGW’s attachment to the VPC.
Parameters: - gateway (
InternetGatewayResource) – - gatewayAttachment (
VPCGatewayAttachmentResource) –
- gateway (
-
addNatGateway() → string¶ Creates a new managed NAT gateway attached to this public subnet.
Also adds the EIP for the managed NAT.
Returns: A ref to the the NAT Gateway ID Return type: string
-
addDefaultRouteToIGW(gateway, gatewayAttachment)¶ Inherited from
@aws-cdk/aws-ec2.VpcSubnetCreate a default route that points to a passed IGW, with a dependency
on the IGW’s attachment to the VPC.
Protected method
Parameters: - gateway (
InternetGatewayResource) – - gatewayAttachment (
VPCGatewayAttachmentResource) –
- gateway (
-
addDefaultRouteToNAT(natGatewayId)¶ Inherited from
@aws-cdk/aws-ec2.VpcSubnetProtected method
Parameters: natGatewayId (string) –
-
availabilityZone¶ Inherited from
@aws-cdk/aws-ec2.VpcSubnetThe Availability Zone the subnet is located in
Type: string (readonly)
-
subnetId¶ Inherited from
@aws-cdk/aws-ec2.VpcSubnetThe subnetId for this particular subnet
Type: string (readonly)
Inherited from
@aws-cdk/aws-ec2.VpcSubnetManage tags for Construct and propagate to children
Type: @aws-cdk/cdk.TagManager(readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/aws-ec2.VpcSubnetRefParts of this VPC subnet
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
- parent (
VpcSubnet¶
-
class
@aws-cdk/aws-ec2.VpcSubnet(parent, name, props)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcSubnet;
const { VpcSubnet } = require('@aws-cdk/aws-ec2');
import { VpcSubnet } from '@aws-cdk/aws-ec2';
Represents a new VPC subnet resource
Extends: Implements: Parameters: - parent (
@aws-cdk/cdk.Construct) – - name (string) –
- props (
VpcSubnetProps) –
-
addDefaultRouteToIGW(gateway, gatewayAttachment)¶ Create a default route that points to a passed IGW, with a dependency
on the IGW’s attachment to the VPC.
Protected method
Parameters: - gateway (
InternetGatewayResource) – - gatewayAttachment (
VPCGatewayAttachmentResource) –
- gateway (
-
addDefaultRouteToNAT(natGatewayId)¶ Protected method
Parameters: natGatewayId (string) –
-
availabilityZone¶ Implements
@aws-cdk/aws-ec2.VpcSubnetRef.availabilityZone()The Availability Zone the subnet is located in
Type: string (readonly)
-
subnetId¶ Implements
@aws-cdk/aws-ec2.VpcSubnetRef.subnetId()The subnetId for this particular subnet
Type: string (readonly)
Implements
@aws-cdk/cdk.ITaggable.tags()Manage tags for Construct and propagate to children
Type: @aws-cdk/cdk.TagManager(readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/aws-ec2.VpcSubnetRefParts of this VPC subnet
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
- parent (
VpcSubnetProps (interface)¶
-
class
@aws-cdk/aws-ec2.VpcSubnetProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcSubnetProps;
// VpcSubnetProps is an interfaceimport { VpcSubnetProps } from '@aws-cdk/aws-ec2';
Specify configuration parameters for a VPC subnet
-
availabilityZone¶ The availability zone for the subnet
Type: string
-
cidrBlock¶ The CIDR notation for this subnet
Type: string
-
vpcId¶ The VPC which this subnet is part of
Type: string
-
mapPublicIpOnLaunch¶ Controls if a public IP is associated to an instance at launch
Defaults to true in Subnet.Public, false in Subnet.Private or Subnet.Isolated.
Type: boolean (optional)
The AWS resource tags to associate with the Subnet
Type: string => string (optional)
-
VpcSubnetRef¶
-
class
@aws-cdk/aws-ec2.VpcSubnetRef(parent, id)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcSubnetRef;
const { VpcSubnetRef } = require('@aws-cdk/aws-ec2');
import { VpcSubnetRef } from '@aws-cdk/aws-ec2';
A new or imported VPC Subnet
Extends: Implements: Abstract: Yes
Parameters: - parent (
@aws-cdk/cdk.Construct) – The parent construct - id (string) –
-
static
import(parent, name, props) → @aws-cdk/aws-ec2.VpcSubnetRef¶ Parameters: - parent (
@aws-cdk/cdk.Construct) – - name (string) –
- props (
VpcSubnetRefProps) –
Return type: - parent (
-
availabilityZone¶ The Availability Zone the subnet is located in
Type: string (readonly) (abstract)
-
dependencyElements¶ Implements
@aws-cdk/cdk.IDependable.dependencyElements()Parts of this VPC subnet
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
subnetId¶ The subnetId for this particular subnet
Type: string (readonly) (abstract)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
- parent (
VpcSubnetRefProps (interface)¶
-
class
@aws-cdk/aws-ec2.VpcSubnetRefProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.VpcSubnetRefProps;
// VpcSubnetRefProps is an interfaceimport { VpcSubnetRefProps } from '@aws-cdk/aws-ec2';
-
availabilityZone¶ The Availability Zone the subnet is located in
Type: string
-
subnetId¶ The subnetId for this particular subnet
Type: string
-
WindowsImage¶
-
class
@aws-cdk/aws-ec2.WindowsImage(version)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.WindowsImage;
const { WindowsImage } = require('@aws-cdk/aws-ec2');
import { WindowsImage } from '@aws-cdk/aws-ec2';
Select the latest version of the indicated Windows version
The AMI ID is selected using the values published to the SSM parameter store.
Implements: IMachineImageSourceParameters: version ( WindowsVersion) –-
getImage(parent) → @aws-cdk/aws-ec2.MachineImage¶ Implements
@aws-cdk/aws-ec2.IMachineImageSource.getImage()Return the image to use in the given context
Parameters: parent ( @aws-cdk/cdk.Construct) –Return type: MachineImage
-
version¶ Type: WindowsVersion(readonly)
-
WindowsOS¶
-
class
@aws-cdk/aws-ec2.WindowsOS¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.WindowsOS;
const { WindowsOS } = require('@aws-cdk/aws-ec2');
import { WindowsOS } from '@aws-cdk/aws-ec2';
OS features specialized for Windows
Extends: OperatingSystem-
createUserData(scripts) → string¶ Implements
@aws-cdk/aws-ec2.OperatingSystem.createUserData()Parameters: scripts (string[]) – Return type: string
-
type¶ Implements
@aws-cdk/aws-ec2.OperatingSystem.type()Type: OperatingSystemType(readonly)
-
WindowsVersion (enum)¶
-
class
@aws-cdk/aws-ec2.WindowsVersion¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.WindowsVersion;
const { WindowsVersion } = require('@aws-cdk/aws-ec2');
import { WindowsVersion } from '@aws-cdk/aws-ec2';
The Windows version to use for the WindowsImage
-
WindowsServer2016TurksihFullBase¶
-
WindowsServer2016SwedishFullBase¶
-
WindowsServer2016SpanishFullBase¶
-
WindowsServer2016RussianFullBase¶
-
WindowsServer2016PortuguesePortugalFullBase¶
-
WindowsServer2016PortugueseBrazilFullBase¶
-
WindowsServer2016PolishFullBase¶
-
WindowsServer2016KoreanFullSQL2016Base¶
-
WindowsServer2016KoreanFullBase¶
-
WindowsServer2016JapaneseFullSQL2016Web¶
-
WindowsServer2016JapaneseFullSQL2016Standard¶
-
WindowsServer2016JapaneseFullSQL2016Express¶
-
WindowsServer2016JapaneseFullSQL2016Enterprise¶
-
WindowsServer2016JapaneseFullBase¶
-
WindowsServer2016ItalianFullBase¶
-
WindowsServer2016HungarianFullBase¶
-
WindowsServer2016GermanFullBase¶
-
WindowsServer2016FrenchFullBase¶
-
WindowsServer2016EnglishNanoBase¶
-
WindowsServer2016EnglishFullSQL2017Web¶
-
WindowsServer2016EnglishFullSQL2017Standard¶
-
WindowsServer2016EnglishFullSQL2017Express¶
-
WindowsServer2016EnglishFullSQL2017Enterprise¶
-
cloudformation¶
CustomerGatewayResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.CustomerGatewayResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.CustomerGatewayResource;
const { cloudformation.CustomerGatewayResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.CustomerGatewayResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisCustomerGatewayResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
CustomerGatewayResourceProps) – the properties of thisCustomerGatewayResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
customerGatewayName¶ Type: string (readonly)
-
propertyOverrides¶ Type: CustomerGatewayResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
CustomerGatewayResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.CustomerGatewayResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.CustomerGatewayResourceProps;
// cloudformation.CustomerGatewayResourceProps is an interfaceimport { cloudformation.CustomerGatewayResourceProps } from '@aws-cdk/aws-ec2';
-
bgpAsn¶ AWS::EC2::CustomerGateway.BgpAsnType: number or @aws-cdk/cdk.Token
-
ipAddress¶ AWS::EC2::CustomerGateway.IpAddressType: string or @aws-cdk/cdk.Token
-
type¶ AWS::EC2::CustomerGateway.TypeType: string or @aws-cdk/cdk.Token
AWS::EC2::CustomerGateway.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
DHCPOptionsResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.DHCPOptionsResource(parent, name[, properties])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.DHCPOptionsResource;
const { cloudformation.DHCPOptionsResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.DHCPOptionsResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisDHCPOptionsResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
DHCPOptionsResourceProps(optional)) – the properties of thisDHCPOptionsResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
dhcpOptionsName¶ Type: string (readonly)
-
propertyOverrides¶ Type: DHCPOptionsResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
DHCPOptionsResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.DHCPOptionsResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.DHCPOptionsResourceProps;
// cloudformation.DHCPOptionsResourceProps is an interfaceimport { cloudformation.DHCPOptionsResourceProps } from '@aws-cdk/aws-ec2';
-
domainName¶ AWS::EC2::DHCPOptions.DomainNameType: string or @aws-cdk/cdk.Token(optional)
-
domainNameServers¶ AWS::EC2::DHCPOptions.DomainNameServersType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
-
netbiosNameServers¶ AWS::EC2::DHCPOptions.NetbiosNameServersType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
-
netbiosNodeType¶ AWS::EC2::DHCPOptions.NetbiosNodeTypeType: number or @aws-cdk/cdk.Token(optional)
-
ntpServers¶ AWS::EC2::DHCPOptions.NtpServersType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
AWS::EC2::DHCPOptions.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
EC2FleetResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.EC2FleetResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EC2FleetResource;
const { cloudformation.EC2FleetResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.EC2FleetResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisEC2FleetResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
EC2FleetResourceProps) – the properties of thisEC2FleetResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
ec2FleetId¶ Type: string (readonly)
-
propertyOverrides¶ Type: EC2FleetResourceProps(readonly)
-
class
FleetLaunchTemplateConfigRequestProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EC2FleetResource.FleetLaunchTemplateConfigRequestProperty;
// cloudformation.EC2FleetResource.FleetLaunchTemplateConfigRequestProperty is an interfaceimport { cloudformation.EC2FleetResource.FleetLaunchTemplateConfigRequestProperty } from '@aws-cdk/aws-ec2';
-
launchTemplateSpecification¶ EC2FleetResource.FleetLaunchTemplateConfigRequestProperty.LaunchTemplateSpecificationType: @aws-cdk/cdk.TokenorFleetLaunchTemplateSpecificationRequestProperty(optional)
-
overrides¶ EC2FleetResource.FleetLaunchTemplateConfigRequestProperty.OverridesType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorFleetLaunchTemplateOverridesRequestProperty)[] (optional)
-
-
class
FleetLaunchTemplateOverridesRequestProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EC2FleetResource.FleetLaunchTemplateOverridesRequestProperty;
// cloudformation.EC2FleetResource.FleetLaunchTemplateOverridesRequestProperty is an interfaceimport { cloudformation.EC2FleetResource.FleetLaunchTemplateOverridesRequestProperty } from '@aws-cdk/aws-ec2';
-
availabilityZone¶ EC2FleetResource.FleetLaunchTemplateOverridesRequestProperty.AvailabilityZoneType: string or @aws-cdk/cdk.Token(optional)
-
instanceType¶ EC2FleetResource.FleetLaunchTemplateOverridesRequestProperty.InstanceTypeType: string or @aws-cdk/cdk.Token(optional)
-
maxPrice¶ EC2FleetResource.FleetLaunchTemplateOverridesRequestProperty.MaxPriceType: string or @aws-cdk/cdk.Token(optional)
-
priority¶ EC2FleetResource.FleetLaunchTemplateOverridesRequestProperty.PriorityType: number or @aws-cdk/cdk.Token(optional)
-
subnetId¶ EC2FleetResource.FleetLaunchTemplateOverridesRequestProperty.SubnetIdType: string or @aws-cdk/cdk.Token(optional)
-
weightedCapacity¶ EC2FleetResource.FleetLaunchTemplateOverridesRequestProperty.WeightedCapacityType: number or @aws-cdk/cdk.Token(optional)
-
-
class
FleetLaunchTemplateSpecificationRequestProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EC2FleetResource.FleetLaunchTemplateSpecificationRequestProperty;
// cloudformation.EC2FleetResource.FleetLaunchTemplateSpecificationRequestProperty is an interfaceimport { cloudformation.EC2FleetResource.FleetLaunchTemplateSpecificationRequestProperty } from '@aws-cdk/aws-ec2';
-
launchTemplateId¶ EC2FleetResource.FleetLaunchTemplateSpecificationRequestProperty.LaunchTemplateIdType: string or @aws-cdk/cdk.Token(optional)
-
launchTemplateName¶ EC2FleetResource.FleetLaunchTemplateSpecificationRequestProperty.LaunchTemplateNameType: string or @aws-cdk/cdk.Token(optional)
-
version¶ EC2FleetResource.FleetLaunchTemplateSpecificationRequestProperty.VersionType: string or @aws-cdk/cdk.Token(optional)
-
-
class
OnDemandOptionsRequestProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EC2FleetResource.OnDemandOptionsRequestProperty;
// cloudformation.EC2FleetResource.OnDemandOptionsRequestProperty is an interfaceimport { cloudformation.EC2FleetResource.OnDemandOptionsRequestProperty } from '@aws-cdk/aws-ec2';
-
allocationStrategy¶ EC2FleetResource.OnDemandOptionsRequestProperty.AllocationStrategyType: string or @aws-cdk/cdk.Token(optional)
-
-
class
SpotOptionsRequestProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EC2FleetResource.SpotOptionsRequestProperty;
// cloudformation.EC2FleetResource.SpotOptionsRequestProperty is an interfaceimport { cloudformation.EC2FleetResource.SpotOptionsRequestProperty } from '@aws-cdk/aws-ec2';
-
allocationStrategy¶ EC2FleetResource.SpotOptionsRequestProperty.AllocationStrategyType: string or @aws-cdk/cdk.Token(optional)
-
instanceInterruptionBehavior¶ EC2FleetResource.SpotOptionsRequestProperty.InstanceInterruptionBehaviorType: string or @aws-cdk/cdk.Token(optional)
-
instancePoolsToUseCount¶ EC2FleetResource.SpotOptionsRequestProperty.InstancePoolsToUseCountType: number or @aws-cdk/cdk.Token(optional)
-
-
class
TagRequestProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EC2FleetResource.TagRequestProperty;
// cloudformation.EC2FleetResource.TagRequestProperty is an interfaceimport { cloudformation.EC2FleetResource.TagRequestProperty } from '@aws-cdk/aws-ec2';
-
key¶ EC2FleetResource.TagRequestProperty.KeyType: string or @aws-cdk/cdk.Token(optional)
-
value¶ EC2FleetResource.TagRequestProperty.ValueType: string or @aws-cdk/cdk.Token(optional)
-
-
class
TagSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EC2FleetResource.TagSpecificationProperty;
// cloudformation.EC2FleetResource.TagSpecificationProperty is an interfaceimport { cloudformation.EC2FleetResource.TagSpecificationProperty } from '@aws-cdk/aws-ec2';
-
resourceType¶ EC2FleetResource.TagSpecificationProperty.ResourceTypeType: string or @aws-cdk/cdk.Token(optional)
EC2FleetResource.TagSpecificationProperty.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorTagRequestProperty)[] (optional)
-
-
class
TargetCapacitySpecificationRequestProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EC2FleetResource.TargetCapacitySpecificationRequestProperty;
// cloudformation.EC2FleetResource.TargetCapacitySpecificationRequestProperty is an interfaceimport { cloudformation.EC2FleetResource.TargetCapacitySpecificationRequestProperty } from '@aws-cdk/aws-ec2';
-
totalTargetCapacity¶ EC2FleetResource.TargetCapacitySpecificationRequestProperty.TotalTargetCapacityType: number or @aws-cdk/cdk.Token
-
defaultTargetCapacityType¶ EC2FleetResource.TargetCapacitySpecificationRequestProperty.DefaultTargetCapacityTypeType: string or @aws-cdk/cdk.Token(optional)
-
onDemandTargetCapacity¶ EC2FleetResource.TargetCapacitySpecificationRequestProperty.OnDemandTargetCapacityType: number or @aws-cdk/cdk.Token(optional)
-
spotTargetCapacity¶ EC2FleetResource.TargetCapacitySpecificationRequestProperty.SpotTargetCapacityType: number or @aws-cdk/cdk.Token(optional)
-
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
EC2FleetResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.EC2FleetResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EC2FleetResourceProps;
// cloudformation.EC2FleetResourceProps is an interfaceimport { cloudformation.EC2FleetResourceProps } from '@aws-cdk/aws-ec2';
-
launchTemplateConfigs¶ AWS::EC2::EC2Fleet.LaunchTemplateConfigsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorFleetLaunchTemplateConfigRequestProperty)[]
-
targetCapacitySpecification¶ AWS::EC2::EC2Fleet.TargetCapacitySpecificationType: @aws-cdk/cdk.TokenorTargetCapacitySpecificationRequestProperty
-
excessCapacityTerminationPolicy¶ AWS::EC2::EC2Fleet.ExcessCapacityTerminationPolicyType: string or @aws-cdk/cdk.Token(optional)
-
onDemandOptions¶ AWS::EC2::EC2Fleet.OnDemandOptionsType: @aws-cdk/cdk.TokenorOnDemandOptionsRequestProperty(optional)
-
replaceUnhealthyInstances¶ AWS::EC2::EC2Fleet.ReplaceUnhealthyInstancesType: boolean or @aws-cdk/cdk.Token(optional)
-
spotOptions¶ AWS::EC2::EC2Fleet.SpotOptionsType: @aws-cdk/cdk.TokenorSpotOptionsRequestProperty(optional)
-
tagSpecifications¶ AWS::EC2::EC2Fleet.TagSpecificationsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorTagSpecificationProperty)[] (optional)
-
terminateInstancesWithExpiration¶ AWS::EC2::EC2Fleet.TerminateInstancesWithExpirationType: boolean or @aws-cdk/cdk.Token(optional)
-
type¶ AWS::EC2::EC2Fleet.TypeType: string or @aws-cdk/cdk.Token(optional)
-
validFrom¶ AWS::EC2::EC2Fleet.ValidFromType: number or @aws-cdk/cdk.Token(optional)
-
validUntil¶ AWS::EC2::EC2Fleet.ValidUntilType: number or @aws-cdk/cdk.Token(optional)
-
EIPAssociationResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.EIPAssociationResource(parent, name[, properties])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EIPAssociationResource;
const { cloudformation.EIPAssociationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.EIPAssociationResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisEIPAssociationResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
EIPAssociationResourceProps(optional)) – the properties of thisEIPAssociationResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
eipAssociationName¶ Type: string (readonly)
-
propertyOverrides¶ Type: EIPAssociationResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
EIPAssociationResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.EIPAssociationResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EIPAssociationResourceProps;
// cloudformation.EIPAssociationResourceProps is an interfaceimport { cloudformation.EIPAssociationResourceProps } from '@aws-cdk/aws-ec2';
-
allocationId¶ AWS::EC2::EIPAssociation.AllocationIdType: string or @aws-cdk/cdk.Token(optional)
-
eip¶ AWS::EC2::EIPAssociation.EIPType: string or @aws-cdk/cdk.Token(optional)
-
instanceId¶ AWS::EC2::EIPAssociation.InstanceIdType: string or @aws-cdk/cdk.Token(optional)
-
networkInterfaceId¶ AWS::EC2::EIPAssociation.NetworkInterfaceIdType: string or @aws-cdk/cdk.Token(optional)
-
privateIpAddress¶ AWS::EC2::EIPAssociation.PrivateIpAddressType: string or @aws-cdk/cdk.Token(optional)
-
EIPResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.EIPResource(parent, name[, properties])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EIPResource;
const { cloudformation.EIPResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.EIPResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisEIPResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
EIPResourceProps(optional)) – the properties of thisEIPResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
eipAllocationId¶ Type: string (readonly)
-
eipIp¶ Type: string (readonly)
-
propertyOverrides¶ Type: EIPResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
EIPResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.EIPResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EIPResourceProps;
// cloudformation.EIPResourceProps is an interfaceimport { cloudformation.EIPResourceProps } from '@aws-cdk/aws-ec2';
-
domain¶ AWS::EC2::EIP.DomainType: string or @aws-cdk/cdk.Token(optional)
-
instanceId¶ AWS::EC2::EIP.InstanceIdType: string or @aws-cdk/cdk.Token(optional)
-
publicIpv4Pool¶ AWS::EC2::EIP.PublicIpv4PoolType: string or @aws-cdk/cdk.Token(optional)
-
EgressOnlyInternetGatewayResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.EgressOnlyInternetGatewayResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EgressOnlyInternetGatewayResource;
const { cloudformation.EgressOnlyInternetGatewayResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.EgressOnlyInternetGatewayResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisEgressOnlyInternetGatewayResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
EgressOnlyInternetGatewayResourceProps) – the properties of thisEgressOnlyInternetGatewayResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
egressOnlyInternetGatewayId¶ Type: string (readonly)
-
propertyOverrides¶ Type: EgressOnlyInternetGatewayResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
EgressOnlyInternetGatewayResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.EgressOnlyInternetGatewayResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.EgressOnlyInternetGatewayResourceProps;
// cloudformation.EgressOnlyInternetGatewayResourceProps is an interfaceimport { cloudformation.EgressOnlyInternetGatewayResourceProps } from '@aws-cdk/aws-ec2';
-
vpcId¶ AWS::EC2::EgressOnlyInternetGateway.VpcIdType: string or @aws-cdk/cdk.Token
-
FlowLogResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.FlowLogResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.FlowLogResource;
const { cloudformation.FlowLogResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.FlowLogResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisFlowLogResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
FlowLogResourceProps) – the properties of thisFlowLogResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
flowLogId¶ Type: string (readonly)
-
propertyOverrides¶ Type: FlowLogResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
FlowLogResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.FlowLogResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.FlowLogResourceProps;
// cloudformation.FlowLogResourceProps is an interfaceimport { cloudformation.FlowLogResourceProps } from '@aws-cdk/aws-ec2';
-
resourceId¶ AWS::EC2::FlowLog.ResourceIdType: string or @aws-cdk/cdk.Token
-
resourceType¶ AWS::EC2::FlowLog.ResourceTypeType: string or @aws-cdk/cdk.Token
-
trafficType¶ AWS::EC2::FlowLog.TrafficTypeType: string or @aws-cdk/cdk.Token
-
deliverLogsPermissionArn¶ AWS::EC2::FlowLog.DeliverLogsPermissionArnType: string or @aws-cdk/cdk.Token(optional)
-
logDestination¶ AWS::EC2::FlowLog.LogDestinationType: string or @aws-cdk/cdk.Token(optional)
-
logDestinationType¶ AWS::EC2::FlowLog.LogDestinationTypeType: string or @aws-cdk/cdk.Token(optional)
-
logGroupName¶ AWS::EC2::FlowLog.LogGroupNameType: string or @aws-cdk/cdk.Token(optional)
-
HostResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.HostResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.HostResource;
const { cloudformation.HostResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.HostResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisHostResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
HostResourceProps) – the properties of thisHostResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
hostId¶ Type: string (readonly)
-
propertyOverrides¶ Type: HostResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
HostResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.HostResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.HostResourceProps;
// cloudformation.HostResourceProps is an interfaceimport { cloudformation.HostResourceProps } from '@aws-cdk/aws-ec2';
-
availabilityZone¶ AWS::EC2::Host.AvailabilityZoneType: string or @aws-cdk/cdk.Token
-
instanceType¶ AWS::EC2::Host.InstanceTypeType: string or @aws-cdk/cdk.Token
-
autoPlacement¶ AWS::EC2::Host.AutoPlacementType: string or @aws-cdk/cdk.Token(optional)
-
InstanceResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.InstanceResource(parent, name[, properties])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource;
const { cloudformation.InstanceResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.InstanceResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisInstanceResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
InstanceResourceProps(optional)) – the properties of thisInstanceResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
instanceAvailabilityZone¶ Type: string (readonly)
-
instanceId¶ Type: string (readonly)
-
instancePrivateDnsName¶ Type: string (readonly)
-
instancePrivateIp¶ Type: string (readonly)
-
instancePublicDnsName¶ Type: string (readonly)
-
instancePublicIp¶ Type: string (readonly)
-
propertyOverrides¶ Type: InstanceResourceProps(readonly)
-
class
AssociationParameterProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.AssociationParameterProperty;
// cloudformation.InstanceResource.AssociationParameterProperty is an interfaceimport { cloudformation.InstanceResource.AssociationParameterProperty } from '@aws-cdk/aws-ec2';
-
key¶ InstanceResource.AssociationParameterProperty.KeyType: string or @aws-cdk/cdk.Token
-
value¶ InstanceResource.AssociationParameterProperty.ValueType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[]
-
-
class
BlockDeviceMappingProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.BlockDeviceMappingProperty;
// cloudformation.InstanceResource.BlockDeviceMappingProperty is an interfaceimport { cloudformation.InstanceResource.BlockDeviceMappingProperty } from '@aws-cdk/aws-ec2';
-
deviceName¶ InstanceResource.BlockDeviceMappingProperty.DeviceNameType: string or @aws-cdk/cdk.Token
-
ebs¶ InstanceResource.BlockDeviceMappingProperty.EbsType: @aws-cdk/cdk.TokenorEbsProperty(optional)
-
noDevice¶ InstanceResource.BlockDeviceMappingProperty.NoDeviceType: @aws-cdk/cdk.TokenorNoDeviceProperty(optional)
-
virtualName¶ InstanceResource.BlockDeviceMappingProperty.VirtualNameType: string or @aws-cdk/cdk.Token(optional)
-
-
class
CreditSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.CreditSpecificationProperty;
// cloudformation.InstanceResource.CreditSpecificationProperty is an interfaceimport { cloudformation.InstanceResource.CreditSpecificationProperty } from '@aws-cdk/aws-ec2';
-
cpuCredits¶ InstanceResource.CreditSpecificationProperty.CPUCreditsType: string or @aws-cdk/cdk.Token(optional)
-
-
class
EbsProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.EbsProperty;
// cloudformation.InstanceResource.EbsProperty is an interfaceimport { cloudformation.InstanceResource.EbsProperty } from '@aws-cdk/aws-ec2';
-
deleteOnTermination¶ InstanceResource.EbsProperty.DeleteOnTerminationType: boolean or @aws-cdk/cdk.Token(optional)
-
encrypted¶ InstanceResource.EbsProperty.EncryptedType: boolean or @aws-cdk/cdk.Token(optional)
-
iops¶ InstanceResource.EbsProperty.IopsType: number or @aws-cdk/cdk.Token(optional)
-
snapshotId¶ InstanceResource.EbsProperty.SnapshotIdType: string or @aws-cdk/cdk.Token(optional)
-
volumeSize¶ InstanceResource.EbsProperty.VolumeSizeType: number or @aws-cdk/cdk.Token(optional)
-
volumeType¶ InstanceResource.EbsProperty.VolumeTypeType: string or @aws-cdk/cdk.Token(optional)
-
-
class
ElasticGpuSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.ElasticGpuSpecificationProperty;
// cloudformation.InstanceResource.ElasticGpuSpecificationProperty is an interfaceimport { cloudformation.InstanceResource.ElasticGpuSpecificationProperty } from '@aws-cdk/aws-ec2';
-
type¶ InstanceResource.ElasticGpuSpecificationProperty.TypeType: string or @aws-cdk/cdk.Token
-
-
class
ElasticInferenceAcceleratorProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.ElasticInferenceAcceleratorProperty;
// cloudformation.InstanceResource.ElasticInferenceAcceleratorProperty is an interfaceimport { cloudformation.InstanceResource.ElasticInferenceAcceleratorProperty } from '@aws-cdk/aws-ec2';
-
type¶ InstanceResource.ElasticInferenceAcceleratorProperty.TypeType: string or @aws-cdk/cdk.Token
-
-
class
InstanceIpv6AddressProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.InstanceIpv6AddressProperty;
// cloudformation.InstanceResource.InstanceIpv6AddressProperty is an interfaceimport { cloudformation.InstanceResource.InstanceIpv6AddressProperty } from '@aws-cdk/aws-ec2';
-
ipv6Address¶ InstanceResource.InstanceIpv6AddressProperty.Ipv6AddressType: string or @aws-cdk/cdk.Token
-
-
class
LaunchTemplateSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.LaunchTemplateSpecificationProperty;
// cloudformation.InstanceResource.LaunchTemplateSpecificationProperty is an interfaceimport { cloudformation.InstanceResource.LaunchTemplateSpecificationProperty } from '@aws-cdk/aws-ec2';
-
version¶ InstanceResource.LaunchTemplateSpecificationProperty.VersionType: string or @aws-cdk/cdk.Token
-
launchTemplateId¶ InstanceResource.LaunchTemplateSpecificationProperty.LaunchTemplateIdType: string or @aws-cdk/cdk.Token(optional)
-
launchTemplateName¶ InstanceResource.LaunchTemplateSpecificationProperty.LaunchTemplateNameType: string or @aws-cdk/cdk.Token(optional)
-
-
class
LicenseSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.LicenseSpecificationProperty;
// cloudformation.InstanceResource.LicenseSpecificationProperty is an interfaceimport { cloudformation.InstanceResource.LicenseSpecificationProperty } from '@aws-cdk/aws-ec2';
-
licenseConfigurationArn¶ InstanceResource.LicenseSpecificationProperty.LicenseConfigurationArnType: string or @aws-cdk/cdk.Token
-
-
class
NetworkInterfaceProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.NetworkInterfaceProperty;
// cloudformation.InstanceResource.NetworkInterfaceProperty is an interfaceimport { cloudformation.InstanceResource.NetworkInterfaceProperty } from '@aws-cdk/aws-ec2';
-
deviceIndex¶ InstanceResource.NetworkInterfaceProperty.DeviceIndexType: string or @aws-cdk/cdk.Token
-
associatePublicIpAddress¶ InstanceResource.NetworkInterfaceProperty.AssociatePublicIpAddressType: boolean or @aws-cdk/cdk.Token(optional)
-
deleteOnTermination¶ InstanceResource.NetworkInterfaceProperty.DeleteOnTerminationType: boolean or @aws-cdk/cdk.Token(optional)
-
description¶ InstanceResource.NetworkInterfaceProperty.DescriptionType: string or @aws-cdk/cdk.Token(optional)
-
groupSet¶ InstanceResource.NetworkInterfaceProperty.GroupSetType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
-
ipv6AddressCount¶ InstanceResource.NetworkInterfaceProperty.Ipv6AddressCountType: number or @aws-cdk/cdk.Token(optional)
-
ipv6Addresses¶ InstanceResource.NetworkInterfaceProperty.Ipv6AddressesType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorInstanceIpv6AddressProperty)[] (optional)
-
networkInterfaceId¶ InstanceResource.NetworkInterfaceProperty.NetworkInterfaceIdType: string or @aws-cdk/cdk.Token(optional)
-
privateIpAddress¶ InstanceResource.NetworkInterfaceProperty.PrivateIpAddressType: string or @aws-cdk/cdk.Token(optional)
-
privateIpAddresses¶ InstanceResource.NetworkInterfaceProperty.PrivateIpAddressesType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorPrivateIpAddressSpecificationProperty)[] (optional)
-
secondaryPrivateIpAddressCount¶ InstanceResource.NetworkInterfaceProperty.SecondaryPrivateIpAddressCountType: number or @aws-cdk/cdk.Token(optional)
-
subnetId¶ InstanceResource.NetworkInterfaceProperty.SubnetIdType: string or @aws-cdk/cdk.Token(optional)
-
-
class
NoDeviceProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.NoDeviceProperty;
// cloudformation.InstanceResource.NoDeviceProperty is an interfaceimport { cloudformation.InstanceResource.NoDeviceProperty } from '@aws-cdk/aws-ec2';
-
class
PrivateIpAddressSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.PrivateIpAddressSpecificationProperty;
// cloudformation.InstanceResource.PrivateIpAddressSpecificationProperty is an interfaceimport { cloudformation.InstanceResource.PrivateIpAddressSpecificationProperty } from '@aws-cdk/aws-ec2';
-
primary¶ InstanceResource.PrivateIpAddressSpecificationProperty.PrimaryType: boolean or @aws-cdk/cdk.Token
-
privateIpAddress¶ InstanceResource.PrivateIpAddressSpecificationProperty.PrivateIpAddressType: string or @aws-cdk/cdk.Token
-
-
class
SsmAssociationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.SsmAssociationProperty;
// cloudformation.InstanceResource.SsmAssociationProperty is an interfaceimport { cloudformation.InstanceResource.SsmAssociationProperty } from '@aws-cdk/aws-ec2';
-
documentName¶ InstanceResource.SsmAssociationProperty.DocumentNameType: string or @aws-cdk/cdk.Token
-
associationParameters¶ InstanceResource.SsmAssociationProperty.AssociationParametersType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorAssociationParameterProperty)[] (optional)
-
-
class
VolumeProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResource.VolumeProperty;
// cloudformation.InstanceResource.VolumeProperty is an interfaceimport { cloudformation.InstanceResource.VolumeProperty } from '@aws-cdk/aws-ec2';
-
device¶ InstanceResource.VolumeProperty.DeviceType: string or @aws-cdk/cdk.Token
-
volumeId¶ InstanceResource.VolumeProperty.VolumeIdType: string or @aws-cdk/cdk.Token
-
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
InstanceResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.InstanceResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InstanceResourceProps;
// cloudformation.InstanceResourceProps is an interfaceimport { cloudformation.InstanceResourceProps } from '@aws-cdk/aws-ec2';
-
additionalInfo¶ AWS::EC2::Instance.AdditionalInfoType: string or @aws-cdk/cdk.Token(optional)
-
affinity¶ AWS::EC2::Instance.AffinityType: string or @aws-cdk/cdk.Token(optional)
-
availabilityZone¶ AWS::EC2::Instance.AvailabilityZoneType: string or @aws-cdk/cdk.Token(optional)
-
blockDeviceMappings¶ AWS::EC2::Instance.BlockDeviceMappingsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorBlockDeviceMappingProperty)[] (optional)
-
creditSpecification¶ AWS::EC2::Instance.CreditSpecificationType: @aws-cdk/cdk.TokenorCreditSpecificationProperty(optional)
-
disableApiTermination¶ AWS::EC2::Instance.DisableApiTerminationType: boolean or @aws-cdk/cdk.Token(optional)
-
ebsOptimized¶ AWS::EC2::Instance.EbsOptimizedType: boolean or @aws-cdk/cdk.Token(optional)
-
elasticGpuSpecifications¶ AWS::EC2::Instance.ElasticGpuSpecificationsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorElasticGpuSpecificationProperty)[] (optional)
-
elasticInferenceAccelerators¶ AWS::EC2::Instance.ElasticInferenceAcceleratorsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorElasticInferenceAcceleratorProperty)[] (optional)
-
hostId¶ AWS::EC2::Instance.HostIdType: string or @aws-cdk/cdk.Token(optional)
-
iamInstanceProfile¶ AWS::EC2::Instance.IamInstanceProfileType: string or @aws-cdk/cdk.Token(optional)
-
imageId¶ AWS::EC2::Instance.ImageIdType: string or @aws-cdk/cdk.Token(optional)
-
instanceInitiatedShutdownBehavior¶ AWS::EC2::Instance.InstanceInitiatedShutdownBehaviorType: string or @aws-cdk/cdk.Token(optional)
-
instanceType¶ AWS::EC2::Instance.InstanceTypeType: string or @aws-cdk/cdk.Token(optional)
-
ipv6AddressCount¶ AWS::EC2::Instance.Ipv6AddressCountType: number or @aws-cdk/cdk.Token(optional)
-
ipv6Addresses¶ AWS::EC2::Instance.Ipv6AddressesType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorInstanceIpv6AddressProperty)[] (optional)
-
kernelId¶ AWS::EC2::Instance.KernelIdType: string or @aws-cdk/cdk.Token(optional)
-
keyName¶ AWS::EC2::Instance.KeyNameType: string or @aws-cdk/cdk.Token(optional)
-
launchTemplate¶ AWS::EC2::Instance.LaunchTemplateType: @aws-cdk/cdk.TokenorLaunchTemplateSpecificationProperty(optional)
-
licenseSpecifications¶ AWS::EC2::Instance.LicenseSpecificationsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorLicenseSpecificationProperty)[] (optional)
-
monitoring¶ AWS::EC2::Instance.MonitoringType: boolean or @aws-cdk/cdk.Token(optional)
-
networkInterfaces¶ AWS::EC2::Instance.NetworkInterfacesType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorNetworkInterfaceProperty)[] (optional)
-
placementGroupName¶ AWS::EC2::Instance.PlacementGroupNameType: string or @aws-cdk/cdk.Token(optional)
-
privateIpAddress¶ AWS::EC2::Instance.PrivateIpAddressType: string or @aws-cdk/cdk.Token(optional)
-
ramdiskId¶ AWS::EC2::Instance.RamdiskIdType: string or @aws-cdk/cdk.Token(optional)
-
securityGroupIds¶ AWS::EC2::Instance.SecurityGroupIdsType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
-
securityGroups¶ AWS::EC2::Instance.SecurityGroupsType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
-
sourceDestCheck¶ AWS::EC2::Instance.SourceDestCheckType: boolean or @aws-cdk/cdk.Token(optional)
-
ssmAssociations¶ AWS::EC2::Instance.SsmAssociationsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorSsmAssociationProperty)[] (optional)
-
subnetId¶ AWS::EC2::Instance.SubnetIdType: string or @aws-cdk/cdk.Token(optional)
AWS::EC2::Instance.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
tenancy¶ AWS::EC2::Instance.TenancyType: string or @aws-cdk/cdk.Token(optional)
-
userData¶ AWS::EC2::Instance.UserDataType: string or @aws-cdk/cdk.Token(optional)
-
volumes¶ AWS::EC2::Instance.VolumesType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorVolumeProperty)[] (optional)
-
InternetGatewayResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.InternetGatewayResource(parent, name[, properties])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InternetGatewayResource;
const { cloudformation.InternetGatewayResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.InternetGatewayResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisInternetGatewayResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
InternetGatewayResourceProps(optional)) – the properties of thisInternetGatewayResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
internetGatewayName¶ Type: string (readonly)
-
propertyOverrides¶ Type: InternetGatewayResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
InternetGatewayResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.InternetGatewayResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.InternetGatewayResourceProps;
// cloudformation.InternetGatewayResourceProps is an interfaceimport { cloudformation.InternetGatewayResourceProps } from '@aws-cdk/aws-ec2';
AWS::EC2::InternetGateway.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
LaunchTemplateResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.LaunchTemplateResource(parent, name[, properties])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource;
const { cloudformation.LaunchTemplateResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.LaunchTemplateResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisLaunchTemplateResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
LaunchTemplateResourceProps(optional)) – the properties of thisLaunchTemplateResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
launchTemplateDefaultVersionNumber¶ Type: string (readonly)
-
launchTemplateId¶ Type: string (readonly)
-
launchTemplateLatestVersionNumber¶ Type: string (readonly)
-
propertyOverrides¶ Type: LaunchTemplateResourceProps(readonly)
-
class
BlockDeviceMappingProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.BlockDeviceMappingProperty;
// cloudformation.LaunchTemplateResource.BlockDeviceMappingProperty is an interfaceimport { cloudformation.LaunchTemplateResource.BlockDeviceMappingProperty } from '@aws-cdk/aws-ec2';
-
deviceName¶ LaunchTemplateResource.BlockDeviceMappingProperty.DeviceNameType: string or @aws-cdk/cdk.Token(optional)
-
ebs¶ LaunchTemplateResource.BlockDeviceMappingProperty.EbsType: @aws-cdk/cdk.TokenorEbsProperty(optional)
-
noDevice¶ LaunchTemplateResource.BlockDeviceMappingProperty.NoDeviceType: string or @aws-cdk/cdk.Token(optional)
-
virtualName¶ LaunchTemplateResource.BlockDeviceMappingProperty.VirtualNameType: string or @aws-cdk/cdk.Token(optional)
-
-
class
CreditSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.CreditSpecificationProperty;
// cloudformation.LaunchTemplateResource.CreditSpecificationProperty is an interfaceimport { cloudformation.LaunchTemplateResource.CreditSpecificationProperty } from '@aws-cdk/aws-ec2';
-
cpuCredits¶ LaunchTemplateResource.CreditSpecificationProperty.CpuCreditsType: string or @aws-cdk/cdk.Token(optional)
-
-
class
EbsProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.EbsProperty;
// cloudformation.LaunchTemplateResource.EbsProperty is an interfaceimport { cloudformation.LaunchTemplateResource.EbsProperty } from '@aws-cdk/aws-ec2';
-
deleteOnTermination¶ LaunchTemplateResource.EbsProperty.DeleteOnTerminationType: boolean or @aws-cdk/cdk.Token(optional)
-
encrypted¶ LaunchTemplateResource.EbsProperty.EncryptedType: boolean or @aws-cdk/cdk.Token(optional)
-
iops¶ LaunchTemplateResource.EbsProperty.IopsType: number or @aws-cdk/cdk.Token(optional)
-
kmsKeyId¶ LaunchTemplateResource.EbsProperty.KmsKeyIdType: string or @aws-cdk/cdk.Token(optional)
-
snapshotId¶ LaunchTemplateResource.EbsProperty.SnapshotIdType: string or @aws-cdk/cdk.Token(optional)
-
volumeSize¶ LaunchTemplateResource.EbsProperty.VolumeSizeType: number or @aws-cdk/cdk.Token(optional)
-
volumeType¶ LaunchTemplateResource.EbsProperty.VolumeTypeType: string or @aws-cdk/cdk.Token(optional)
-
-
class
ElasticGpuSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.ElasticGpuSpecificationProperty;
// cloudformation.LaunchTemplateResource.ElasticGpuSpecificationProperty is an interfaceimport { cloudformation.LaunchTemplateResource.ElasticGpuSpecificationProperty } from '@aws-cdk/aws-ec2';
-
type¶ LaunchTemplateResource.ElasticGpuSpecificationProperty.TypeType: string or @aws-cdk/cdk.Token(optional)
-
-
class
IamInstanceProfileProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.IamInstanceProfileProperty;
// cloudformation.LaunchTemplateResource.IamInstanceProfileProperty is an interfaceimport { cloudformation.LaunchTemplateResource.IamInstanceProfileProperty } from '@aws-cdk/aws-ec2';
-
arn¶ LaunchTemplateResource.IamInstanceProfileProperty.ArnType: string or @aws-cdk/cdk.Token(optional)
-
name¶ LaunchTemplateResource.IamInstanceProfileProperty.NameType: string or @aws-cdk/cdk.Token(optional)
-
-
class
InstanceMarketOptionsProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.InstanceMarketOptionsProperty;
// cloudformation.LaunchTemplateResource.InstanceMarketOptionsProperty is an interfaceimport { cloudformation.LaunchTemplateResource.InstanceMarketOptionsProperty } from '@aws-cdk/aws-ec2';
-
marketType¶ LaunchTemplateResource.InstanceMarketOptionsProperty.MarketTypeType: string or @aws-cdk/cdk.Token(optional)
-
spotOptions¶ LaunchTemplateResource.InstanceMarketOptionsProperty.SpotOptionsType: @aws-cdk/cdk.TokenorSpotOptionsProperty(optional)
-
-
class
Ipv6AddProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.Ipv6AddProperty;
// cloudformation.LaunchTemplateResource.Ipv6AddProperty is an interfaceimport { cloudformation.LaunchTemplateResource.Ipv6AddProperty } from '@aws-cdk/aws-ec2';
-
ipv6Address¶ LaunchTemplateResource.Ipv6AddProperty.Ipv6AddressType: string or @aws-cdk/cdk.Token(optional)
-
-
class
LaunchTemplateDataProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.LaunchTemplateDataProperty;
// cloudformation.LaunchTemplateResource.LaunchTemplateDataProperty is an interfaceimport { cloudformation.LaunchTemplateResource.LaunchTemplateDataProperty } from '@aws-cdk/aws-ec2';
-
blockDeviceMappings¶ LaunchTemplateResource.LaunchTemplateDataProperty.BlockDeviceMappingsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorBlockDeviceMappingProperty)[] (optional)
-
creditSpecification¶ LaunchTemplateResource.LaunchTemplateDataProperty.CreditSpecificationType: @aws-cdk/cdk.TokenorCreditSpecificationProperty(optional)
-
disableApiTermination¶ LaunchTemplateResource.LaunchTemplateDataProperty.DisableApiTerminationType: boolean or @aws-cdk/cdk.Token(optional)
-
ebsOptimized¶ LaunchTemplateResource.LaunchTemplateDataProperty.EbsOptimizedType: boolean or @aws-cdk/cdk.Token(optional)
-
elasticGpuSpecifications¶ LaunchTemplateResource.LaunchTemplateDataProperty.ElasticGpuSpecificationsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorElasticGpuSpecificationProperty)[] (optional)
-
iamInstanceProfile¶ LaunchTemplateResource.LaunchTemplateDataProperty.IamInstanceProfileType: @aws-cdk/cdk.TokenorIamInstanceProfileProperty(optional)
-
imageId¶ LaunchTemplateResource.LaunchTemplateDataProperty.ImageIdType: string or @aws-cdk/cdk.Token(optional)
-
instanceInitiatedShutdownBehavior¶ LaunchTemplateResource.LaunchTemplateDataProperty.InstanceInitiatedShutdownBehaviorType: string or @aws-cdk/cdk.Token(optional)
-
instanceMarketOptions¶ LaunchTemplateResource.LaunchTemplateDataProperty.InstanceMarketOptionsType: @aws-cdk/cdk.TokenorInstanceMarketOptionsProperty(optional)
-
instanceType¶ LaunchTemplateResource.LaunchTemplateDataProperty.InstanceTypeType: string or @aws-cdk/cdk.Token(optional)
-
kernelId¶ LaunchTemplateResource.LaunchTemplateDataProperty.KernelIdType: string or @aws-cdk/cdk.Token(optional)
-
keyName¶ LaunchTemplateResource.LaunchTemplateDataProperty.KeyNameType: string or @aws-cdk/cdk.Token(optional)
-
monitoring¶ LaunchTemplateResource.LaunchTemplateDataProperty.MonitoringType: @aws-cdk/cdk.TokenorMonitoringProperty(optional)
-
networkInterfaces¶ LaunchTemplateResource.LaunchTemplateDataProperty.NetworkInterfacesType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorNetworkInterfaceProperty)[] (optional)
-
placement¶ LaunchTemplateResource.LaunchTemplateDataProperty.PlacementType: @aws-cdk/cdk.TokenorPlacementProperty(optional)
-
ramDiskId¶ LaunchTemplateResource.LaunchTemplateDataProperty.RamDiskIdType: string or @aws-cdk/cdk.Token(optional)
-
securityGroupIds¶ LaunchTemplateResource.LaunchTemplateDataProperty.SecurityGroupIdsType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
-
securityGroups¶ LaunchTemplateResource.LaunchTemplateDataProperty.SecurityGroupsType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
-
tagSpecifications¶ LaunchTemplateResource.LaunchTemplateDataProperty.TagSpecificationsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorTagSpecificationProperty)[] (optional)
-
userData¶ LaunchTemplateResource.LaunchTemplateDataProperty.UserDataType: string or @aws-cdk/cdk.Token(optional)
-
-
class
MonitoringProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.MonitoringProperty;
// cloudformation.LaunchTemplateResource.MonitoringProperty is an interfaceimport { cloudformation.LaunchTemplateResource.MonitoringProperty } from '@aws-cdk/aws-ec2';
-
enabled¶ LaunchTemplateResource.MonitoringProperty.EnabledType: boolean or @aws-cdk/cdk.Token(optional)
-
-
class
NetworkInterfaceProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.NetworkInterfaceProperty;
// cloudformation.LaunchTemplateResource.NetworkInterfaceProperty is an interfaceimport { cloudformation.LaunchTemplateResource.NetworkInterfaceProperty } from '@aws-cdk/aws-ec2';
-
associatePublicIpAddress¶ LaunchTemplateResource.NetworkInterfaceProperty.AssociatePublicIpAddressType: boolean or @aws-cdk/cdk.Token(optional)
-
deleteOnTermination¶ LaunchTemplateResource.NetworkInterfaceProperty.DeleteOnTerminationType: boolean or @aws-cdk/cdk.Token(optional)
-
description¶ LaunchTemplateResource.NetworkInterfaceProperty.DescriptionType: string or @aws-cdk/cdk.Token(optional)
-
deviceIndex¶ LaunchTemplateResource.NetworkInterfaceProperty.DeviceIndexType: number or @aws-cdk/cdk.Token(optional)
-
groups¶ LaunchTemplateResource.NetworkInterfaceProperty.GroupsType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
-
ipv6AddressCount¶ LaunchTemplateResource.NetworkInterfaceProperty.Ipv6AddressCountType: number or @aws-cdk/cdk.Token(optional)
-
ipv6Addresses¶ LaunchTemplateResource.NetworkInterfaceProperty.Ipv6AddressesType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorIpv6AddProperty)[] (optional)
-
networkInterfaceId¶ LaunchTemplateResource.NetworkInterfaceProperty.NetworkInterfaceIdType: string or @aws-cdk/cdk.Token(optional)
-
privateIpAddress¶ LaunchTemplateResource.NetworkInterfaceProperty.PrivateIpAddressType: string or @aws-cdk/cdk.Token(optional)
-
privateIpAddresses¶ LaunchTemplateResource.NetworkInterfaceProperty.PrivateIpAddressesType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorPrivateIpAddProperty)[] (optional)
-
secondaryPrivateIpAddressCount¶ LaunchTemplateResource.NetworkInterfaceProperty.SecondaryPrivateIpAddressCountType: number or @aws-cdk/cdk.Token(optional)
-
subnetId¶ LaunchTemplateResource.NetworkInterfaceProperty.SubnetIdType: string or @aws-cdk/cdk.Token(optional)
-
-
class
PlacementProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.PlacementProperty;
// cloudformation.LaunchTemplateResource.PlacementProperty is an interfaceimport { cloudformation.LaunchTemplateResource.PlacementProperty } from '@aws-cdk/aws-ec2';
-
affinity¶ LaunchTemplateResource.PlacementProperty.AffinityType: string or @aws-cdk/cdk.Token(optional)
-
availabilityZone¶ LaunchTemplateResource.PlacementProperty.AvailabilityZoneType: string or @aws-cdk/cdk.Token(optional)
-
groupName¶ LaunchTemplateResource.PlacementProperty.GroupNameType: string or @aws-cdk/cdk.Token(optional)
-
hostId¶ LaunchTemplateResource.PlacementProperty.HostIdType: string or @aws-cdk/cdk.Token(optional)
-
tenancy¶ LaunchTemplateResource.PlacementProperty.TenancyType: string or @aws-cdk/cdk.Token(optional)
-
-
class
PrivateIpAddProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.PrivateIpAddProperty;
// cloudformation.LaunchTemplateResource.PrivateIpAddProperty is an interfaceimport { cloudformation.LaunchTemplateResource.PrivateIpAddProperty } from '@aws-cdk/aws-ec2';
-
primary¶ LaunchTemplateResource.PrivateIpAddProperty.PrimaryType: boolean or @aws-cdk/cdk.Token(optional)
-
privateIpAddress¶ LaunchTemplateResource.PrivateIpAddProperty.PrivateIpAddressType: string or @aws-cdk/cdk.Token(optional)
-
-
class
SpotOptionsProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.SpotOptionsProperty;
// cloudformation.LaunchTemplateResource.SpotOptionsProperty is an interfaceimport { cloudformation.LaunchTemplateResource.SpotOptionsProperty } from '@aws-cdk/aws-ec2';
-
instanceInterruptionBehavior¶ LaunchTemplateResource.SpotOptionsProperty.InstanceInterruptionBehaviorType: string or @aws-cdk/cdk.Token(optional)
-
maxPrice¶ LaunchTemplateResource.SpotOptionsProperty.MaxPriceType: string or @aws-cdk/cdk.Token(optional)
-
spotInstanceType¶ LaunchTemplateResource.SpotOptionsProperty.SpotInstanceTypeType: string or @aws-cdk/cdk.Token(optional)
-
-
class
TagSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResource.TagSpecificationProperty;
// cloudformation.LaunchTemplateResource.TagSpecificationProperty is an interfaceimport { cloudformation.LaunchTemplateResource.TagSpecificationProperty } from '@aws-cdk/aws-ec2';
-
resourceType¶ LaunchTemplateResource.TagSpecificationProperty.ResourceTypeType: string or @aws-cdk/cdk.Token(optional)
LaunchTemplateResource.TagSpecificationProperty.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
LaunchTemplateResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.LaunchTemplateResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.LaunchTemplateResourceProps;
// cloudformation.LaunchTemplateResourceProps is an interfaceimport { cloudformation.LaunchTemplateResourceProps } from '@aws-cdk/aws-ec2';
-
launchTemplateData¶ AWS::EC2::LaunchTemplate.LaunchTemplateDataType: @aws-cdk/cdk.TokenorLaunchTemplateDataProperty(optional)
-
launchTemplateName¶ AWS::EC2::LaunchTemplate.LaunchTemplateNameType: string or @aws-cdk/cdk.Token(optional)
-
NatGatewayResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.NatGatewayResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NatGatewayResource;
const { cloudformation.NatGatewayResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.NatGatewayResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisNatGatewayResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
NatGatewayResourceProps) – the properties of thisNatGatewayResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
natGatewayId¶ Type: string (readonly)
-
propertyOverrides¶ Type: NatGatewayResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
NatGatewayResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.NatGatewayResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NatGatewayResourceProps;
// cloudformation.NatGatewayResourceProps is an interfaceimport { cloudformation.NatGatewayResourceProps } from '@aws-cdk/aws-ec2';
-
allocationId¶ AWS::EC2::NatGateway.AllocationIdType: string or @aws-cdk/cdk.Token
-
subnetId¶ AWS::EC2::NatGateway.SubnetIdType: string or @aws-cdk/cdk.Token
AWS::EC2::NatGateway.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
NetworkAclEntryResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.NetworkAclEntryResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkAclEntryResource;
const { cloudformation.NetworkAclEntryResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.NetworkAclEntryResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisNetworkAclEntryResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
NetworkAclEntryResourceProps) – the properties of thisNetworkAclEntryResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
networkAclEntryName¶ Type: string (readonly)
-
propertyOverrides¶ Type: NetworkAclEntryResourceProps(readonly)
-
class
IcmpProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkAclEntryResource.IcmpProperty;
// cloudformation.NetworkAclEntryResource.IcmpProperty is an interfaceimport { cloudformation.NetworkAclEntryResource.IcmpProperty } from '@aws-cdk/aws-ec2';
-
code¶ NetworkAclEntryResource.IcmpProperty.CodeType: number or @aws-cdk/cdk.Token(optional)
-
type¶ NetworkAclEntryResource.IcmpProperty.TypeType: number or @aws-cdk/cdk.Token(optional)
-
-
class
PortRangeProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkAclEntryResource.PortRangeProperty;
// cloudformation.NetworkAclEntryResource.PortRangeProperty is an interfaceimport { cloudformation.NetworkAclEntryResource.PortRangeProperty } from '@aws-cdk/aws-ec2';
-
from¶ NetworkAclEntryResource.PortRangeProperty.FromType: number or @aws-cdk/cdk.Token(optional)
-
to¶ NetworkAclEntryResource.PortRangeProperty.ToType: number or @aws-cdk/cdk.Token(optional)
-
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
NetworkAclEntryResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.NetworkAclEntryResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkAclEntryResourceProps;
// cloudformation.NetworkAclEntryResourceProps is an interfaceimport { cloudformation.NetworkAclEntryResourceProps } from '@aws-cdk/aws-ec2';
-
cidrBlock¶ AWS::EC2::NetworkAclEntry.CidrBlockType: string or @aws-cdk/cdk.Token
-
networkAclId¶ AWS::EC2::NetworkAclEntry.NetworkAclIdType: string or @aws-cdk/cdk.Token
-
protocol¶ AWS::EC2::NetworkAclEntry.ProtocolType: number or @aws-cdk/cdk.Token
-
ruleAction¶ AWS::EC2::NetworkAclEntry.RuleActionType: string or @aws-cdk/cdk.Token
-
ruleNumber¶ AWS::EC2::NetworkAclEntry.RuleNumberType: number or @aws-cdk/cdk.Token
-
egress¶ AWS::EC2::NetworkAclEntry.EgressType: boolean or @aws-cdk/cdk.Token(optional)
-
icmp¶ AWS::EC2::NetworkAclEntry.IcmpType: @aws-cdk/cdk.TokenorIcmpProperty(optional)
-
ipv6CidrBlock¶ AWS::EC2::NetworkAclEntry.Ipv6CidrBlockType: string or @aws-cdk/cdk.Token(optional)
-
portRange¶ AWS::EC2::NetworkAclEntry.PortRangeType: @aws-cdk/cdk.TokenorPortRangeProperty(optional)
-
NetworkAclResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.NetworkAclResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkAclResource;
const { cloudformation.NetworkAclResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.NetworkAclResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisNetworkAclResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
NetworkAclResourceProps) – the properties of thisNetworkAclResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
networkAclName¶ Type: string (readonly)
-
propertyOverrides¶ Type: NetworkAclResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
NetworkAclResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.NetworkAclResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkAclResourceProps;
// cloudformation.NetworkAclResourceProps is an interfaceimport { cloudformation.NetworkAclResourceProps } from '@aws-cdk/aws-ec2';
-
vpcId¶ AWS::EC2::NetworkAcl.VpcIdType: string or @aws-cdk/cdk.Token
AWS::EC2::NetworkAcl.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
NetworkInterfaceAttachmentResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.NetworkInterfaceAttachmentResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfaceAttachmentResource;
const { cloudformation.NetworkInterfaceAttachmentResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.NetworkInterfaceAttachmentResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisNetworkInterfaceAttachmentResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
NetworkInterfaceAttachmentResourceProps) – the properties of thisNetworkInterfaceAttachmentResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
networkInterfaceAttachmentName¶ Type: string (readonly)
-
propertyOverrides¶ Type: NetworkInterfaceAttachmentResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
NetworkInterfaceAttachmentResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.NetworkInterfaceAttachmentResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfaceAttachmentResourceProps;
// cloudformation.NetworkInterfaceAttachmentResourceProps is an interfaceimport { cloudformation.NetworkInterfaceAttachmentResourceProps } from '@aws-cdk/aws-ec2';
-
deviceIndex¶ AWS::EC2::NetworkInterfaceAttachment.DeviceIndexType: string or @aws-cdk/cdk.Token
-
instanceId¶ AWS::EC2::NetworkInterfaceAttachment.InstanceIdType: string or @aws-cdk/cdk.Token
-
networkInterfaceId¶ AWS::EC2::NetworkInterfaceAttachment.NetworkInterfaceIdType: string or @aws-cdk/cdk.Token
-
deleteOnTermination¶ AWS::EC2::NetworkInterfaceAttachment.DeleteOnTerminationType: boolean or @aws-cdk/cdk.Token(optional)
-
NetworkInterfacePermissionResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.NetworkInterfacePermissionResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfacePermissionResource;
const { cloudformation.NetworkInterfacePermissionResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.NetworkInterfacePermissionResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisNetworkInterfacePermissionResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
NetworkInterfacePermissionResourceProps) – the properties of thisNetworkInterfacePermissionResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
networkInterfacePermissionId¶ Type: string (readonly)
-
propertyOverrides¶ Type: NetworkInterfacePermissionResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
NetworkInterfacePermissionResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.NetworkInterfacePermissionResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfacePermissionResourceProps;
// cloudformation.NetworkInterfacePermissionResourceProps is an interfaceimport { cloudformation.NetworkInterfacePermissionResourceProps } from '@aws-cdk/aws-ec2';
-
awsAccountId¶ AWS::EC2::NetworkInterfacePermission.AwsAccountIdType: string or @aws-cdk/cdk.Token
-
networkInterfaceId¶ AWS::EC2::NetworkInterfacePermission.NetworkInterfaceIdType: string or @aws-cdk/cdk.Token
-
permission¶ AWS::EC2::NetworkInterfacePermission.PermissionType: string or @aws-cdk/cdk.Token
-
NetworkInterfaceResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.NetworkInterfaceResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfaceResource;
const { cloudformation.NetworkInterfaceResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.NetworkInterfaceResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisNetworkInterfaceResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
NetworkInterfaceResourceProps) – the properties of thisNetworkInterfaceResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
networkInterfaceName¶ Type: string (readonly)
-
networkInterfacePrimaryPrivateIpAddress¶ Type: string (readonly)
-
networkInterfaceSecondaryPrivateIpAddresses¶ Type: NetworkInterfaceSecondaryPrivateIpAddresses(readonly)
-
propertyOverrides¶ Type: NetworkInterfaceResourceProps(readonly)
-
class
InstanceIpv6AddressProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfaceResource.InstanceIpv6AddressProperty;
// cloudformation.NetworkInterfaceResource.InstanceIpv6AddressProperty is an interfaceimport { cloudformation.NetworkInterfaceResource.InstanceIpv6AddressProperty } from '@aws-cdk/aws-ec2';
-
ipv6Address¶ NetworkInterfaceResource.InstanceIpv6AddressProperty.Ipv6AddressType: string or @aws-cdk/cdk.Token
-
-
class
PrivateIpAddressSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfaceResource.PrivateIpAddressSpecificationProperty;
// cloudformation.NetworkInterfaceResource.PrivateIpAddressSpecificationProperty is an interfaceimport { cloudformation.NetworkInterfaceResource.PrivateIpAddressSpecificationProperty } from '@aws-cdk/aws-ec2';
-
primary¶ NetworkInterfaceResource.PrivateIpAddressSpecificationProperty.PrimaryType: boolean or @aws-cdk/cdk.Token
-
privateIpAddress¶ NetworkInterfaceResource.PrivateIpAddressSpecificationProperty.PrivateIpAddressType: string or @aws-cdk/cdk.Token
-
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
NetworkInterfaceResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.NetworkInterfaceResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.NetworkInterfaceResourceProps;
// cloudformation.NetworkInterfaceResourceProps is an interfaceimport { cloudformation.NetworkInterfaceResourceProps } from '@aws-cdk/aws-ec2';
-
subnetId¶ AWS::EC2::NetworkInterface.SubnetIdType: string or @aws-cdk/cdk.Token
-
description¶ AWS::EC2::NetworkInterface.DescriptionType: string or @aws-cdk/cdk.Token(optional)
-
groupSet¶ AWS::EC2::NetworkInterface.GroupSetType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
-
interfaceType¶ AWS::EC2::NetworkInterface.InterfaceTypeType: string or @aws-cdk/cdk.Token(optional)
-
ipv6AddressCount¶ AWS::EC2::NetworkInterface.Ipv6AddressCountType: number or @aws-cdk/cdk.Token(optional)
-
ipv6Addresses¶ AWS::EC2::NetworkInterface.Ipv6AddressesType: @aws-cdk/cdk.TokenorInstanceIpv6AddressProperty(optional)
-
privateIpAddress¶ AWS::EC2::NetworkInterface.PrivateIpAddressType: string or @aws-cdk/cdk.Token(optional)
-
privateIpAddresses¶ AWS::EC2::NetworkInterface.PrivateIpAddressesType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorPrivateIpAddressSpecificationProperty)[] (optional)
-
secondaryPrivateIpAddressCount¶ AWS::EC2::NetworkInterface.SecondaryPrivateIpAddressCountType: number or @aws-cdk/cdk.Token(optional)
-
sourceDestCheck¶ AWS::EC2::NetworkInterface.SourceDestCheckType: boolean or @aws-cdk/cdk.Token(optional)
AWS::EC2::NetworkInterface.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
PlacementGroupResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.PlacementGroupResource(parent, name[, properties])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.PlacementGroupResource;
const { cloudformation.PlacementGroupResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.PlacementGroupResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisPlacementGroupResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
PlacementGroupResourceProps(optional)) – the properties of thisPlacementGroupResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
placementGroupName¶ Type: string (readonly)
-
propertyOverrides¶ Type: PlacementGroupResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
PlacementGroupResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.PlacementGroupResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.PlacementGroupResourceProps;
// cloudformation.PlacementGroupResourceProps is an interfaceimport { cloudformation.PlacementGroupResourceProps } from '@aws-cdk/aws-ec2';
-
strategy¶ AWS::EC2::PlacementGroup.StrategyType: string or @aws-cdk/cdk.Token(optional)
-
RouteResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.RouteResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.RouteResource;
const { cloudformation.RouteResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.RouteResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisRouteResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
RouteResourceProps) – the properties of thisRouteResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: RouteResourceProps(readonly)
-
routeName¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
RouteResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.RouteResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.RouteResourceProps;
// cloudformation.RouteResourceProps is an interfaceimport { cloudformation.RouteResourceProps } from '@aws-cdk/aws-ec2';
-
routeTableId¶ AWS::EC2::Route.RouteTableIdType: string or @aws-cdk/cdk.Token
-
destinationCidrBlock¶ AWS::EC2::Route.DestinationCidrBlockType: string or @aws-cdk/cdk.Token(optional)
-
destinationIpv6CidrBlock¶ AWS::EC2::Route.DestinationIpv6CidrBlockType: string or @aws-cdk/cdk.Token(optional)
-
egressOnlyInternetGatewayId¶ AWS::EC2::Route.EgressOnlyInternetGatewayIdType: string or @aws-cdk/cdk.Token(optional)
-
gatewayId¶ AWS::EC2::Route.GatewayIdType: string or @aws-cdk/cdk.Token(optional)
-
instanceId¶ AWS::EC2::Route.InstanceIdType: string or @aws-cdk/cdk.Token(optional)
-
natGatewayId¶ AWS::EC2::Route.NatGatewayIdType: string or @aws-cdk/cdk.Token(optional)
-
networkInterfaceId¶ AWS::EC2::Route.NetworkInterfaceIdType: string or @aws-cdk/cdk.Token(optional)
-
vpcPeeringConnectionId¶ AWS::EC2::Route.VpcPeeringConnectionIdType: string or @aws-cdk/cdk.Token(optional)
-
RouteTableResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.RouteTableResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.RouteTableResource;
const { cloudformation.RouteTableResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.RouteTableResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisRouteTableResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
RouteTableResourceProps) – the properties of thisRouteTableResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: RouteTableResourceProps(readonly)
-
routeTableId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
RouteTableResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.RouteTableResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.RouteTableResourceProps;
// cloudformation.RouteTableResourceProps is an interfaceimport { cloudformation.RouteTableResourceProps } from '@aws-cdk/aws-ec2';
-
vpcId¶ AWS::EC2::RouteTable.VpcIdType: string or @aws-cdk/cdk.Token
AWS::EC2::RouteTable.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
SecurityGroupEgressResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.SecurityGroupEgressResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupEgressResource;
const { cloudformation.SecurityGroupEgressResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SecurityGroupEgressResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisSecurityGroupEgressResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
SecurityGroupEgressResourceProps) – the properties of thisSecurityGroupEgressResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: SecurityGroupEgressResourceProps(readonly)
-
securityGroupEgressId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
SecurityGroupEgressResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.SecurityGroupEgressResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupEgressResourceProps;
// cloudformation.SecurityGroupEgressResourceProps is an interfaceimport { cloudformation.SecurityGroupEgressResourceProps } from '@aws-cdk/aws-ec2';
-
groupId¶ AWS::EC2::SecurityGroupEgress.GroupIdType: string or @aws-cdk/cdk.Token
-
ipProtocol¶ AWS::EC2::SecurityGroupEgress.IpProtocolType: string or @aws-cdk/cdk.Token
-
cidrIp¶ AWS::EC2::SecurityGroupEgress.CidrIpType: string or @aws-cdk/cdk.Token(optional)
-
cidrIpv6¶ AWS::EC2::SecurityGroupEgress.CidrIpv6Type: string or @aws-cdk/cdk.Token(optional)
-
description¶ AWS::EC2::SecurityGroupEgress.DescriptionType: string or @aws-cdk/cdk.Token(optional)
-
destinationPrefixListId¶ AWS::EC2::SecurityGroupEgress.DestinationPrefixListIdType: string or @aws-cdk/cdk.Token(optional)
-
destinationSecurityGroupId¶ AWS::EC2::SecurityGroupEgress.DestinationSecurityGroupIdType: string or @aws-cdk/cdk.Token(optional)
-
fromPort¶ AWS::EC2::SecurityGroupEgress.FromPortType: number or @aws-cdk/cdk.Token(optional)
-
toPort¶ AWS::EC2::SecurityGroupEgress.ToPortType: number or @aws-cdk/cdk.Token(optional)
-
SecurityGroupIngressResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.SecurityGroupIngressResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupIngressResource;
const { cloudformation.SecurityGroupIngressResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SecurityGroupIngressResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisSecurityGroupIngressResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
SecurityGroupIngressResourceProps) – the properties of thisSecurityGroupIngressResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: SecurityGroupIngressResourceProps(readonly)
-
securityGroupIngressId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
SecurityGroupIngressResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.SecurityGroupIngressResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupIngressResourceProps;
// cloudformation.SecurityGroupIngressResourceProps is an interfaceimport { cloudformation.SecurityGroupIngressResourceProps } from '@aws-cdk/aws-ec2';
-
ipProtocol¶ AWS::EC2::SecurityGroupIngress.IpProtocolType: string or @aws-cdk/cdk.Token
-
cidrIp¶ AWS::EC2::SecurityGroupIngress.CidrIpType: string or @aws-cdk/cdk.Token(optional)
-
cidrIpv6¶ AWS::EC2::SecurityGroupIngress.CidrIpv6Type: string or @aws-cdk/cdk.Token(optional)
-
description¶ AWS::EC2::SecurityGroupIngress.DescriptionType: string or @aws-cdk/cdk.Token(optional)
-
fromPort¶ AWS::EC2::SecurityGroupIngress.FromPortType: number or @aws-cdk/cdk.Token(optional)
-
groupId¶ AWS::EC2::SecurityGroupIngress.GroupIdType: string or @aws-cdk/cdk.Token(optional)
-
groupName¶ AWS::EC2::SecurityGroupIngress.GroupNameType: string or @aws-cdk/cdk.Token(optional)
-
sourcePrefixListId¶ AWS::EC2::SecurityGroupIngress.SourcePrefixListIdType: string or @aws-cdk/cdk.Token(optional)
-
sourceSecurityGroupId¶ AWS::EC2::SecurityGroupIngress.SourceSecurityGroupIdType: string or @aws-cdk/cdk.Token(optional)
-
sourceSecurityGroupName¶ AWS::EC2::SecurityGroupIngress.SourceSecurityGroupNameType: string or @aws-cdk/cdk.Token(optional)
-
sourceSecurityGroupOwnerId¶ AWS::EC2::SecurityGroupIngress.SourceSecurityGroupOwnerIdType: string or @aws-cdk/cdk.Token(optional)
-
toPort¶ AWS::EC2::SecurityGroupIngress.ToPortType: number or @aws-cdk/cdk.Token(optional)
-
SecurityGroupResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.SecurityGroupResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupResource;
const { cloudformation.SecurityGroupResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SecurityGroupResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisSecurityGroupResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
SecurityGroupResourceProps) – the properties of thisSecurityGroupResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: SecurityGroupResourceProps(readonly)
-
securityGroupId¶ Type: string (readonly)
-
securityGroupName¶ Type: string (readonly)
-
securityGroupVpcId¶ Type: string (readonly)
-
class
EgressProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupResource.EgressProperty;
// cloudformation.SecurityGroupResource.EgressProperty is an interfaceimport { cloudformation.SecurityGroupResource.EgressProperty } from '@aws-cdk/aws-ec2';
-
ipProtocol¶ SecurityGroupResource.EgressProperty.IpProtocolType: string or @aws-cdk/cdk.Token
-
cidrIp¶ SecurityGroupResource.EgressProperty.CidrIpType: string or @aws-cdk/cdk.Token(optional)
-
cidrIpv6¶ SecurityGroupResource.EgressProperty.CidrIpv6Type: string or @aws-cdk/cdk.Token(optional)
-
description¶ SecurityGroupResource.EgressProperty.DescriptionType: string or @aws-cdk/cdk.Token(optional)
-
destinationPrefixListId¶ SecurityGroupResource.EgressProperty.DestinationPrefixListIdType: string or @aws-cdk/cdk.Token(optional)
-
destinationSecurityGroupId¶ SecurityGroupResource.EgressProperty.DestinationSecurityGroupIdType: string or @aws-cdk/cdk.Token(optional)
-
fromPort¶ SecurityGroupResource.EgressProperty.FromPortType: number or @aws-cdk/cdk.Token(optional)
-
toPort¶ SecurityGroupResource.EgressProperty.ToPortType: number or @aws-cdk/cdk.Token(optional)
-
-
class
IngressProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupResource.IngressProperty;
// cloudformation.SecurityGroupResource.IngressProperty is an interfaceimport { cloudformation.SecurityGroupResource.IngressProperty } from '@aws-cdk/aws-ec2';
-
ipProtocol¶ SecurityGroupResource.IngressProperty.IpProtocolType: string or @aws-cdk/cdk.Token
-
cidrIp¶ SecurityGroupResource.IngressProperty.CidrIpType: string or @aws-cdk/cdk.Token(optional)
-
cidrIpv6¶ SecurityGroupResource.IngressProperty.CidrIpv6Type: string or @aws-cdk/cdk.Token(optional)
-
description¶ SecurityGroupResource.IngressProperty.DescriptionType: string or @aws-cdk/cdk.Token(optional)
-
fromPort¶ SecurityGroupResource.IngressProperty.FromPortType: number or @aws-cdk/cdk.Token(optional)
-
sourcePrefixListId¶ SecurityGroupResource.IngressProperty.SourcePrefixListIdType: string or @aws-cdk/cdk.Token(optional)
-
sourceSecurityGroupId¶ SecurityGroupResource.IngressProperty.SourceSecurityGroupIdType: string or @aws-cdk/cdk.Token(optional)
-
sourceSecurityGroupName¶ SecurityGroupResource.IngressProperty.SourceSecurityGroupNameType: string or @aws-cdk/cdk.Token(optional)
-
sourceSecurityGroupOwnerId¶ SecurityGroupResource.IngressProperty.SourceSecurityGroupOwnerIdType: string or @aws-cdk/cdk.Token(optional)
-
toPort¶ SecurityGroupResource.IngressProperty.ToPortType: number or @aws-cdk/cdk.Token(optional)
-
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
SecurityGroupResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.SecurityGroupResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SecurityGroupResourceProps;
// cloudformation.SecurityGroupResourceProps is an interfaceimport { cloudformation.SecurityGroupResourceProps } from '@aws-cdk/aws-ec2';
-
groupDescription¶ AWS::EC2::SecurityGroup.GroupDescriptionType: string or @aws-cdk/cdk.Token
-
groupName¶ AWS::EC2::SecurityGroup.GroupNameType: string or @aws-cdk/cdk.Token(optional)
-
securityGroupEgress¶ AWS::EC2::SecurityGroup.SecurityGroupEgressType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorEgressProperty)[] (optional)
-
securityGroupIngress¶ AWS::EC2::SecurityGroup.SecurityGroupIngressType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorIngressProperty)[] (optional)
AWS::EC2::SecurityGroup.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
vpcId¶ AWS::EC2::SecurityGroup.VpcIdType: string or @aws-cdk/cdk.Token(optional)
-
SpotFleetResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.SpotFleetResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource;
const { cloudformation.SpotFleetResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SpotFleetResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisSpotFleetResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
SpotFleetResourceProps) – the properties of thisSpotFleetResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: SpotFleetResourceProps(readonly)
-
spotFleetName¶ Type: string (readonly)
-
class
BlockDeviceMappingProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.BlockDeviceMappingProperty;
// cloudformation.SpotFleetResource.BlockDeviceMappingProperty is an interfaceimport { cloudformation.SpotFleetResource.BlockDeviceMappingProperty } from '@aws-cdk/aws-ec2';
-
deviceName¶ SpotFleetResource.BlockDeviceMappingProperty.DeviceNameType: string or @aws-cdk/cdk.Token
-
ebs¶ SpotFleetResource.BlockDeviceMappingProperty.EbsType: @aws-cdk/cdk.TokenorEbsBlockDeviceProperty(optional)
-
noDevice¶ SpotFleetResource.BlockDeviceMappingProperty.NoDeviceType: string or @aws-cdk/cdk.Token(optional)
-
virtualName¶ SpotFleetResource.BlockDeviceMappingProperty.VirtualNameType: string or @aws-cdk/cdk.Token(optional)
-
-
class
ClassicLoadBalancerProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.ClassicLoadBalancerProperty;
// cloudformation.SpotFleetResource.ClassicLoadBalancerProperty is an interfaceimport { cloudformation.SpotFleetResource.ClassicLoadBalancerProperty } from '@aws-cdk/aws-ec2';
-
name¶ SpotFleetResource.ClassicLoadBalancerProperty.NameType: string or @aws-cdk/cdk.Token
-
-
class
ClassicLoadBalancersConfigProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.ClassicLoadBalancersConfigProperty;
// cloudformation.SpotFleetResource.ClassicLoadBalancersConfigProperty is an interfaceimport { cloudformation.SpotFleetResource.ClassicLoadBalancersConfigProperty } from '@aws-cdk/aws-ec2';
-
classicLoadBalancers¶ SpotFleetResource.ClassicLoadBalancersConfigProperty.ClassicLoadBalancersType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorClassicLoadBalancerProperty)[]
-
-
class
EbsBlockDeviceProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.EbsBlockDeviceProperty;
// cloudformation.SpotFleetResource.EbsBlockDeviceProperty is an interfaceimport { cloudformation.SpotFleetResource.EbsBlockDeviceProperty } from '@aws-cdk/aws-ec2';
-
deleteOnTermination¶ SpotFleetResource.EbsBlockDeviceProperty.DeleteOnTerminationType: boolean or @aws-cdk/cdk.Token(optional)
-
encrypted¶ SpotFleetResource.EbsBlockDeviceProperty.EncryptedType: boolean or @aws-cdk/cdk.Token(optional)
-
iops¶ SpotFleetResource.EbsBlockDeviceProperty.IopsType: number or @aws-cdk/cdk.Token(optional)
-
snapshotId¶ SpotFleetResource.EbsBlockDeviceProperty.SnapshotIdType: string or @aws-cdk/cdk.Token(optional)
-
volumeSize¶ SpotFleetResource.EbsBlockDeviceProperty.VolumeSizeType: number or @aws-cdk/cdk.Token(optional)
-
volumeType¶ SpotFleetResource.EbsBlockDeviceProperty.VolumeTypeType: string or @aws-cdk/cdk.Token(optional)
-
-
class
FleetLaunchTemplateSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.FleetLaunchTemplateSpecificationProperty;
// cloudformation.SpotFleetResource.FleetLaunchTemplateSpecificationProperty is an interfaceimport { cloudformation.SpotFleetResource.FleetLaunchTemplateSpecificationProperty } from '@aws-cdk/aws-ec2';
-
version¶ SpotFleetResource.FleetLaunchTemplateSpecificationProperty.VersionType: string or @aws-cdk/cdk.Token
-
launchTemplateId¶ SpotFleetResource.FleetLaunchTemplateSpecificationProperty.LaunchTemplateIdType: string or @aws-cdk/cdk.Token(optional)
-
launchTemplateName¶ SpotFleetResource.FleetLaunchTemplateSpecificationProperty.LaunchTemplateNameType: string or @aws-cdk/cdk.Token(optional)
-
-
class
GroupIdentifierProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.GroupIdentifierProperty;
// cloudformation.SpotFleetResource.GroupIdentifierProperty is an interfaceimport { cloudformation.SpotFleetResource.GroupIdentifierProperty } from '@aws-cdk/aws-ec2';
-
groupId¶ SpotFleetResource.GroupIdentifierProperty.GroupIdType: string or @aws-cdk/cdk.Token
-
-
class
IamInstanceProfileSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.IamInstanceProfileSpecificationProperty;
// cloudformation.SpotFleetResource.IamInstanceProfileSpecificationProperty is an interfaceimport { cloudformation.SpotFleetResource.IamInstanceProfileSpecificationProperty } from '@aws-cdk/aws-ec2';
-
arn¶ SpotFleetResource.IamInstanceProfileSpecificationProperty.ArnType: string or @aws-cdk/cdk.Token(optional)
-
-
class
InstanceIpv6AddressProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.InstanceIpv6AddressProperty;
// cloudformation.SpotFleetResource.InstanceIpv6AddressProperty is an interfaceimport { cloudformation.SpotFleetResource.InstanceIpv6AddressProperty } from '@aws-cdk/aws-ec2';
-
ipv6Address¶ SpotFleetResource.InstanceIpv6AddressProperty.Ipv6AddressType: string or @aws-cdk/cdk.Token
-
-
class
InstanceNetworkInterfaceSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty;
// cloudformation.SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty is an interfaceimport { cloudformation.SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty } from '@aws-cdk/aws-ec2';
-
associatePublicIpAddress¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.AssociatePublicIpAddressType: boolean or @aws-cdk/cdk.Token(optional)
-
deleteOnTermination¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.DeleteOnTerminationType: boolean or @aws-cdk/cdk.Token(optional)
-
description¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.DescriptionType: string or @aws-cdk/cdk.Token(optional)
-
deviceIndex¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.DeviceIndexType: number or @aws-cdk/cdk.Token(optional)
-
groups¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.GroupsType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
-
ipv6AddressCount¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.Ipv6AddressCountType: number or @aws-cdk/cdk.Token(optional)
-
ipv6Addresses¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.Ipv6AddressesType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorInstanceIpv6AddressProperty)[] (optional)
-
networkInterfaceId¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.NetworkInterfaceIdType: string or @aws-cdk/cdk.Token(optional)
-
privateIpAddresses¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.PrivateIpAddressesType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorPrivateIpAddressSpecificationProperty)[] (optional)
-
secondaryPrivateIpAddressCount¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.SecondaryPrivateIpAddressCountType: number or @aws-cdk/cdk.Token(optional)
-
subnetId¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.SubnetIdType: string or @aws-cdk/cdk.Token(optional)
-
-
class
LaunchTemplateConfigProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.LaunchTemplateConfigProperty;
// cloudformation.SpotFleetResource.LaunchTemplateConfigProperty is an interfaceimport { cloudformation.SpotFleetResource.LaunchTemplateConfigProperty } from '@aws-cdk/aws-ec2';
-
launchTemplateSpecification¶ SpotFleetResource.LaunchTemplateConfigProperty.LaunchTemplateSpecificationType: @aws-cdk/cdk.TokenorFleetLaunchTemplateSpecificationProperty(optional)
-
overrides¶ SpotFleetResource.LaunchTemplateConfigProperty.OverridesType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorLaunchTemplateOverridesProperty)[] (optional)
-
-
class
LaunchTemplateOverridesProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.LaunchTemplateOverridesProperty;
// cloudformation.SpotFleetResource.LaunchTemplateOverridesProperty is an interfaceimport { cloudformation.SpotFleetResource.LaunchTemplateOverridesProperty } from '@aws-cdk/aws-ec2';
-
availabilityZone¶ SpotFleetResource.LaunchTemplateOverridesProperty.AvailabilityZoneType: string or @aws-cdk/cdk.Token(optional)
-
instanceType¶ SpotFleetResource.LaunchTemplateOverridesProperty.InstanceTypeType: string or @aws-cdk/cdk.Token(optional)
-
spotPrice¶ SpotFleetResource.LaunchTemplateOverridesProperty.SpotPriceType: string or @aws-cdk/cdk.Token(optional)
-
subnetId¶ SpotFleetResource.LaunchTemplateOverridesProperty.SubnetIdType: string or @aws-cdk/cdk.Token(optional)
-
weightedCapacity¶ SpotFleetResource.LaunchTemplateOverridesProperty.WeightedCapacityType: number or @aws-cdk/cdk.Token(optional)
-
-
class
LoadBalancersConfigProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.LoadBalancersConfigProperty;
// cloudformation.SpotFleetResource.LoadBalancersConfigProperty is an interfaceimport { cloudformation.SpotFleetResource.LoadBalancersConfigProperty } from '@aws-cdk/aws-ec2';
-
classicLoadBalancersConfig¶ SpotFleetResource.LoadBalancersConfigProperty.ClassicLoadBalancersConfigType: @aws-cdk/cdk.TokenorClassicLoadBalancersConfigProperty(optional)
-
targetGroupsConfig¶ SpotFleetResource.LoadBalancersConfigProperty.TargetGroupsConfigType: @aws-cdk/cdk.TokenorTargetGroupsConfigProperty(optional)
-
-
class
PrivateIpAddressSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.PrivateIpAddressSpecificationProperty;
// cloudformation.SpotFleetResource.PrivateIpAddressSpecificationProperty is an interfaceimport { cloudformation.SpotFleetResource.PrivateIpAddressSpecificationProperty } from '@aws-cdk/aws-ec2';
-
privateIpAddress¶ SpotFleetResource.PrivateIpAddressSpecificationProperty.PrivateIpAddressType: string or @aws-cdk/cdk.Token
-
primary¶ SpotFleetResource.PrivateIpAddressSpecificationProperty.PrimaryType: boolean or @aws-cdk/cdk.Token(optional)
-
-
class
SpotFleetLaunchSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.SpotFleetLaunchSpecificationProperty;
// cloudformation.SpotFleetResource.SpotFleetLaunchSpecificationProperty is an interfaceimport { cloudformation.SpotFleetResource.SpotFleetLaunchSpecificationProperty } from '@aws-cdk/aws-ec2';
-
imageId¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.ImageIdType: string or @aws-cdk/cdk.Token
-
instanceType¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.InstanceTypeType: string or @aws-cdk/cdk.Token
-
blockDeviceMappings¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.BlockDeviceMappingsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorBlockDeviceMappingProperty)[] (optional)
-
ebsOptimized¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.EbsOptimizedType: boolean or @aws-cdk/cdk.Token(optional)
-
iamInstanceProfile¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.IamInstanceProfileType: @aws-cdk/cdk.TokenorIamInstanceProfileSpecificationProperty(optional)
-
kernelId¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.KernelIdType: string or @aws-cdk/cdk.Token(optional)
-
keyName¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.KeyNameType: string or @aws-cdk/cdk.Token(optional)
-
monitoring¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.MonitoringType: @aws-cdk/cdk.TokenorSpotFleetMonitoringProperty(optional)
-
networkInterfaces¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.NetworkInterfacesType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorInstanceNetworkInterfaceSpecificationProperty)[] (optional)
-
placement¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.PlacementType: @aws-cdk/cdk.TokenorSpotPlacementProperty(optional)
-
ramdiskId¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.RamdiskIdType: string or @aws-cdk/cdk.Token(optional)
-
securityGroups¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.SecurityGroupsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorGroupIdentifierProperty)[] (optional)
-
spotPrice¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.SpotPriceType: string or @aws-cdk/cdk.Token(optional)
-
subnetId¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.SubnetIdType: string or @aws-cdk/cdk.Token(optional)
-
tagSpecifications¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.TagSpecificationsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorSpotFleetTagSpecificationProperty)[] (optional)
-
userData¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.UserDataType: string or @aws-cdk/cdk.Token(optional)
-
weightedCapacity¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.WeightedCapacityType: number or @aws-cdk/cdk.Token(optional)
-
-
class
SpotFleetMonitoringProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.SpotFleetMonitoringProperty;
// cloudformation.SpotFleetResource.SpotFleetMonitoringProperty is an interfaceimport { cloudformation.SpotFleetResource.SpotFleetMonitoringProperty } from '@aws-cdk/aws-ec2';
-
enabled¶ SpotFleetResource.SpotFleetMonitoringProperty.EnabledType: boolean or @aws-cdk/cdk.Token(optional)
-
-
class
SpotFleetRequestConfigDataProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.SpotFleetRequestConfigDataProperty;
// cloudformation.SpotFleetResource.SpotFleetRequestConfigDataProperty is an interfaceimport { cloudformation.SpotFleetResource.SpotFleetRequestConfigDataProperty } from '@aws-cdk/aws-ec2';
-
iamFleetRole¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.IamFleetRoleType: string or @aws-cdk/cdk.Token
-
targetCapacity¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.TargetCapacityType: number or @aws-cdk/cdk.Token
-
allocationStrategy¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.AllocationStrategyType: string or @aws-cdk/cdk.Token(optional)
-
excessCapacityTerminationPolicy¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.ExcessCapacityTerminationPolicyType: string or @aws-cdk/cdk.Token(optional)
-
instanceInterruptionBehavior¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.InstanceInterruptionBehaviorType: string or @aws-cdk/cdk.Token(optional)
-
launchSpecifications¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.LaunchSpecificationsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorSpotFleetLaunchSpecificationProperty)[] (optional)
-
launchTemplateConfigs¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.LaunchTemplateConfigsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorLaunchTemplateConfigProperty)[] (optional)
-
loadBalancersConfig¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.LoadBalancersConfigType: @aws-cdk/cdk.TokenorLoadBalancersConfigProperty(optional)
-
replaceUnhealthyInstances¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.ReplaceUnhealthyInstancesType: boolean or @aws-cdk/cdk.Token(optional)
-
spotPrice¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.SpotPriceType: string or @aws-cdk/cdk.Token(optional)
-
terminateInstancesWithExpiration¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.TerminateInstancesWithExpirationType: boolean or @aws-cdk/cdk.Token(optional)
-
type¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.TypeType: string or @aws-cdk/cdk.Token(optional)
-
validFrom¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.ValidFromType: string or @aws-cdk/cdk.Token(optional)
-
validUntil¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.ValidUntilType: string or @aws-cdk/cdk.Token(optional)
-
-
class
SpotFleetTagSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.SpotFleetTagSpecificationProperty;
// cloudformation.SpotFleetResource.SpotFleetTagSpecificationProperty is an interfaceimport { cloudformation.SpotFleetResource.SpotFleetTagSpecificationProperty } from '@aws-cdk/aws-ec2';
-
resourceType¶ SpotFleetResource.SpotFleetTagSpecificationProperty.ResourceTypeType: string or @aws-cdk/cdk.Token(optional)
SpotFleetResource.SpotFleetTagSpecificationProperty.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
-
class
SpotPlacementProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.SpotPlacementProperty;
// cloudformation.SpotFleetResource.SpotPlacementProperty is an interfaceimport { cloudformation.SpotFleetResource.SpotPlacementProperty } from '@aws-cdk/aws-ec2';
-
availabilityZone¶ SpotFleetResource.SpotPlacementProperty.AvailabilityZoneType: string or @aws-cdk/cdk.Token(optional)
-
groupName¶ SpotFleetResource.SpotPlacementProperty.GroupNameType: string or @aws-cdk/cdk.Token(optional)
-
tenancy¶ SpotFleetResource.SpotPlacementProperty.TenancyType: string or @aws-cdk/cdk.Token(optional)
-
-
class
TargetGroupProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.TargetGroupProperty;
// cloudformation.SpotFleetResource.TargetGroupProperty is an interfaceimport { cloudformation.SpotFleetResource.TargetGroupProperty } from '@aws-cdk/aws-ec2';
-
arn¶ SpotFleetResource.TargetGroupProperty.ArnType: string or @aws-cdk/cdk.Token
-
-
class
TargetGroupsConfigProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResource.TargetGroupsConfigProperty;
// cloudformation.SpotFleetResource.TargetGroupsConfigProperty is an interfaceimport { cloudformation.SpotFleetResource.TargetGroupsConfigProperty } from '@aws-cdk/aws-ec2';
-
targetGroups¶ SpotFleetResource.TargetGroupsConfigProperty.TargetGroupsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorTargetGroupProperty)[]
-
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
SpotFleetResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.SpotFleetResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SpotFleetResourceProps;
// cloudformation.SpotFleetResourceProps is an interfaceimport { cloudformation.SpotFleetResourceProps } from '@aws-cdk/aws-ec2';
-
spotFleetRequestConfigData¶ AWS::EC2::SpotFleet.SpotFleetRequestConfigDataType: @aws-cdk/cdk.TokenorSpotFleetRequestConfigDataProperty
-
SubnetCidrBlockResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.SubnetCidrBlockResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetCidrBlockResource;
const { cloudformation.SubnetCidrBlockResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SubnetCidrBlockResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisSubnetCidrBlockResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
SubnetCidrBlockResourceProps) – the properties of thisSubnetCidrBlockResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: SubnetCidrBlockResourceProps(readonly)
-
subnetCidrBlockId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
SubnetCidrBlockResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.SubnetCidrBlockResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetCidrBlockResourceProps;
// cloudformation.SubnetCidrBlockResourceProps is an interfaceimport { cloudformation.SubnetCidrBlockResourceProps } from '@aws-cdk/aws-ec2';
-
ipv6CidrBlock¶ AWS::EC2::SubnetCidrBlock.Ipv6CidrBlockType: string or @aws-cdk/cdk.Token
-
subnetId¶ AWS::EC2::SubnetCidrBlock.SubnetIdType: string or @aws-cdk/cdk.Token
-
SubnetNetworkAclAssociationResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.SubnetNetworkAclAssociationResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetNetworkAclAssociationResource;
const { cloudformation.SubnetNetworkAclAssociationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SubnetNetworkAclAssociationResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisSubnetNetworkAclAssociationResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
SubnetNetworkAclAssociationResourceProps) – the properties of thisSubnetNetworkAclAssociationResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: SubnetNetworkAclAssociationResourceProps(readonly)
-
subnetNetworkAclAssociationAssociationId¶ Type: string (readonly)
-
subnetNetworkAclAssociationName¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
SubnetNetworkAclAssociationResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.SubnetNetworkAclAssociationResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetNetworkAclAssociationResourceProps;
// cloudformation.SubnetNetworkAclAssociationResourceProps is an interfaceimport { cloudformation.SubnetNetworkAclAssociationResourceProps } from '@aws-cdk/aws-ec2';
-
networkAclId¶ AWS::EC2::SubnetNetworkAclAssociation.NetworkAclIdType: string or @aws-cdk/cdk.Token
-
subnetId¶ AWS::EC2::SubnetNetworkAclAssociation.SubnetIdType: string or @aws-cdk/cdk.Token
-
SubnetResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.SubnetResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetResource;
const { cloudformation.SubnetResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SubnetResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisSubnetResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
SubnetResourceProps) – the properties of thisSubnetResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: SubnetResourceProps(readonly)
-
subnetAvailabilityZone¶ Type: string (readonly)
-
subnetId¶ Type: string (readonly)
-
subnetIpv6CidrBlocks¶ Type: SubnetIpv6CidrBlocks(readonly)
-
subnetNetworkAclAssociationId¶ Type: string (readonly)
-
subnetVpcId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
SubnetResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.SubnetResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetResourceProps;
// cloudformation.SubnetResourceProps is an interfaceimport { cloudformation.SubnetResourceProps } from '@aws-cdk/aws-ec2';
-
cidrBlock¶ AWS::EC2::Subnet.CidrBlockType: string or @aws-cdk/cdk.Token
-
vpcId¶ AWS::EC2::Subnet.VpcIdType: string or @aws-cdk/cdk.Token
-
assignIpv6AddressOnCreation¶ AWS::EC2::Subnet.AssignIpv6AddressOnCreationType: boolean or @aws-cdk/cdk.Token(optional)
-
availabilityZone¶ AWS::EC2::Subnet.AvailabilityZoneType: string or @aws-cdk/cdk.Token(optional)
-
ipv6CidrBlock¶ AWS::EC2::Subnet.Ipv6CidrBlockType: string or @aws-cdk/cdk.Token(optional)
-
mapPublicIpOnLaunch¶ AWS::EC2::Subnet.MapPublicIpOnLaunchType: boolean or @aws-cdk/cdk.Token(optional)
AWS::EC2::Subnet.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
SubnetRouteTableAssociationResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.SubnetRouteTableAssociationResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetRouteTableAssociationResource;
const { cloudformation.SubnetRouteTableAssociationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.SubnetRouteTableAssociationResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisSubnetRouteTableAssociationResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
SubnetRouteTableAssociationResourceProps) – the properties of thisSubnetRouteTableAssociationResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: SubnetRouteTableAssociationResourceProps(readonly)
-
subnetRouteTableAssociationName¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
SubnetRouteTableAssociationResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.SubnetRouteTableAssociationResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.SubnetRouteTableAssociationResourceProps;
// cloudformation.SubnetRouteTableAssociationResourceProps is an interfaceimport { cloudformation.SubnetRouteTableAssociationResourceProps } from '@aws-cdk/aws-ec2';
-
routeTableId¶ AWS::EC2::SubnetRouteTableAssociation.RouteTableIdType: string or @aws-cdk/cdk.Token
-
subnetId¶ AWS::EC2::SubnetRouteTableAssociation.SubnetIdType: string or @aws-cdk/cdk.Token
-
TransitGatewayAttachmentResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.TransitGatewayAttachmentResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TransitGatewayAttachmentResource;
const { cloudformation.TransitGatewayAttachmentResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.TransitGatewayAttachmentResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisTransitGatewayAttachmentResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
TransitGatewayAttachmentResourceProps) – the properties of thisTransitGatewayAttachmentResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: TransitGatewayAttachmentResourceProps(readonly)
-
transitGatewayAttachmentId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
TransitGatewayAttachmentResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.TransitGatewayAttachmentResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TransitGatewayAttachmentResourceProps;
// cloudformation.TransitGatewayAttachmentResourceProps is an interfaceimport { cloudformation.TransitGatewayAttachmentResourceProps } from '@aws-cdk/aws-ec2';
-
subnetIds¶ AWS::EC2::TransitGatewayAttachment.SubnetIdsType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[]
-
transitGatewayId¶ AWS::EC2::TransitGatewayAttachment.TransitGatewayIdType: string or @aws-cdk/cdk.Token
-
vpcId¶ AWS::EC2::TransitGatewayAttachment.VpcIdType: string or @aws-cdk/cdk.Token
AWS::EC2::TransitGatewayAttachment.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
TransitGatewayResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.TransitGatewayResource(parent, name[, properties])¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TransitGatewayResource;
const { cloudformation.TransitGatewayResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.TransitGatewayResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisTransitGatewayResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
TransitGatewayResourceProps(optional)) – the properties of thisTransitGatewayResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: TransitGatewayResourceProps(readonly)
-
transitGatewayId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
TransitGatewayResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.TransitGatewayResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TransitGatewayResourceProps;
// cloudformation.TransitGatewayResourceProps is an interfaceimport { cloudformation.TransitGatewayResourceProps } from '@aws-cdk/aws-ec2';
-
amazonSideAsn¶ AWS::EC2::TransitGateway.AmazonSideAsnType: number or @aws-cdk/cdk.Token(optional)
AWS::EC2::TransitGateway.AutoAcceptSharedAttachmentsType: string or @aws-cdk/cdk.Token(optional)
-
defaultRouteTableAssociation¶ AWS::EC2::TransitGateway.DefaultRouteTableAssociationType: string or @aws-cdk/cdk.Token(optional)
-
defaultRouteTablePropagation¶ AWS::EC2::TransitGateway.DefaultRouteTablePropagationType: string or @aws-cdk/cdk.Token(optional)
-
description¶ AWS::EC2::TransitGateway.DescriptionType: string or @aws-cdk/cdk.Token(optional)
-
dnsSupport¶ AWS::EC2::TransitGateway.DnsSupportType: string or @aws-cdk/cdk.Token(optional)
AWS::EC2::TransitGateway.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
vpnEcmpSupport¶ AWS::EC2::TransitGateway.VpnEcmpSupportType: string or @aws-cdk/cdk.Token(optional)
-
TransitGatewayRouteResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.TransitGatewayRouteResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TransitGatewayRouteResource;
const { cloudformation.TransitGatewayRouteResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.TransitGatewayRouteResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisTransitGatewayRouteResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
TransitGatewayRouteResourceProps) – the properties of thisTransitGatewayRouteResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: TransitGatewayRouteResourceProps(readonly)
-
transitGatewayRouteId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
TransitGatewayRouteResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.TransitGatewayRouteResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TransitGatewayRouteResourceProps;
// cloudformation.TransitGatewayRouteResourceProps is an interfaceimport { cloudformation.TransitGatewayRouteResourceProps } from '@aws-cdk/aws-ec2';
-
transitGatewayRouteTableId¶ AWS::EC2::TransitGatewayRoute.TransitGatewayRouteTableIdType: string or @aws-cdk/cdk.Token
-
blackhole¶ AWS::EC2::TransitGatewayRoute.BlackholeType: boolean or @aws-cdk/cdk.Token(optional)
-
destinationCidrBlock¶ AWS::EC2::TransitGatewayRoute.DestinationCidrBlockType: string or @aws-cdk/cdk.Token(optional)
-
transitGatewayAttachmentId¶ AWS::EC2::TransitGatewayRoute.TransitGatewayAttachmentIdType: string or @aws-cdk/cdk.Token(optional)
-
TransitGatewayRouteTableAssociationResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.TransitGatewayRouteTableAssociationResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TransitGatewayRouteTableAssociationResource;
const { cloudformation.TransitGatewayRouteTableAssociationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.TransitGatewayRouteTableAssociationResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisTransitGatewayRouteTableAssociationResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
TransitGatewayRouteTableAssociationResourceProps) – the properties of thisTransitGatewayRouteTableAssociationResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: TransitGatewayRouteTableAssociationResourceProps(readonly)
-
transitGatewayRouteTableAssociationId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
TransitGatewayRouteTableAssociationResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.TransitGatewayRouteTableAssociationResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TransitGatewayRouteTableAssociationResourceProps;
// cloudformation.TransitGatewayRouteTableAssociationResourceProps is an interfaceimport { cloudformation.TransitGatewayRouteTableAssociationResourceProps } from '@aws-cdk/aws-ec2';
-
transitGatewayAttachmentId¶ AWS::EC2::TransitGatewayRouteTableAssociation.TransitGatewayAttachmentIdType: string or @aws-cdk/cdk.Token
-
transitGatewayRouteTableId¶ AWS::EC2::TransitGatewayRouteTableAssociation.TransitGatewayRouteTableIdType: string or @aws-cdk/cdk.Token
-
TransitGatewayRouteTablePropagationResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.TransitGatewayRouteTablePropagationResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TransitGatewayRouteTablePropagationResource;
const { cloudformation.TransitGatewayRouteTablePropagationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.TransitGatewayRouteTablePropagationResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisTransitGatewayRouteTablePropagationResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
TransitGatewayRouteTablePropagationResourceProps) – the properties of thisTransitGatewayRouteTablePropagationResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: TransitGatewayRouteTablePropagationResourceProps(readonly)
-
transitGatewayRouteTablePropagationId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
TransitGatewayRouteTablePropagationResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.TransitGatewayRouteTablePropagationResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TransitGatewayRouteTablePropagationResourceProps;
// cloudformation.TransitGatewayRouteTablePropagationResourceProps is an interfaceimport { cloudformation.TransitGatewayRouteTablePropagationResourceProps } from '@aws-cdk/aws-ec2';
-
transitGatewayAttachmentId¶ AWS::EC2::TransitGatewayRouteTablePropagation.TransitGatewayAttachmentIdType: string or @aws-cdk/cdk.Token
-
transitGatewayRouteTableId¶ AWS::EC2::TransitGatewayRouteTablePropagation.TransitGatewayRouteTableIdType: string or @aws-cdk/cdk.Token
-
TransitGatewayRouteTableResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.TransitGatewayRouteTableResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TransitGatewayRouteTableResource;
const { cloudformation.TransitGatewayRouteTableResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.TransitGatewayRouteTableResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisTransitGatewayRouteTableResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
TransitGatewayRouteTableResourceProps) – the properties of thisTransitGatewayRouteTableResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: TransitGatewayRouteTableResourceProps(readonly)
-
transitGatewayRouteTableId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
TransitGatewayRouteTableResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.TransitGatewayRouteTableResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TransitGatewayRouteTableResourceProps;
// cloudformation.TransitGatewayRouteTableResourceProps is an interfaceimport { cloudformation.TransitGatewayRouteTableResourceProps } from '@aws-cdk/aws-ec2';
-
transitGatewayId¶ AWS::EC2::TransitGatewayRouteTable.TransitGatewayIdType: string or @aws-cdk/cdk.Token
AWS::EC2::TransitGatewayRouteTable.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
TrunkInterfaceAssociationResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.TrunkInterfaceAssociationResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TrunkInterfaceAssociationResource;
const { cloudformation.TrunkInterfaceAssociationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.TrunkInterfaceAssociationResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisTrunkInterfaceAssociationResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
TrunkInterfaceAssociationResourceProps) – the properties of thisTrunkInterfaceAssociationResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: TrunkInterfaceAssociationResourceProps(readonly)
-
trunkInterfaceAssociationId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
TrunkInterfaceAssociationResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.TrunkInterfaceAssociationResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.TrunkInterfaceAssociationResourceProps;
// cloudformation.TrunkInterfaceAssociationResourceProps is an interfaceimport { cloudformation.TrunkInterfaceAssociationResourceProps } from '@aws-cdk/aws-ec2';
-
branchInterfaceId¶ AWS::EC2::TrunkInterfaceAssociation.BranchInterfaceIdType: string or @aws-cdk/cdk.Token
-
trunkInterfaceId¶ AWS::EC2::TrunkInterfaceAssociation.TrunkInterfaceIdType: string or @aws-cdk/cdk.Token
-
greKey¶ AWS::EC2::TrunkInterfaceAssociation.GREKeyType: number or @aws-cdk/cdk.Token(optional)
-
vlanId¶ AWS::EC2::TrunkInterfaceAssociation.VLANIdType: number or @aws-cdk/cdk.Token(optional)
-
VPCCidrBlockResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCCidrBlockResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCCidrBlockResource;
const { cloudformation.VPCCidrBlockResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCCidrBlockResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisVPCCidrBlockResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
VPCCidrBlockResourceProps) – the properties of thisVPCCidrBlockResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: VPCCidrBlockResourceProps(readonly)
-
vpcCidrBlockId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
VPCCidrBlockResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCCidrBlockResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCCidrBlockResourceProps;
// cloudformation.VPCCidrBlockResourceProps is an interfaceimport { cloudformation.VPCCidrBlockResourceProps } from '@aws-cdk/aws-ec2';
-
vpcId¶ AWS::EC2::VPCCidrBlock.VpcIdType: string or @aws-cdk/cdk.Token
-
amazonProvidedIpv6CidrBlock¶ AWS::EC2::VPCCidrBlock.AmazonProvidedIpv6CidrBlockType: boolean or @aws-cdk/cdk.Token(optional)
-
cidrBlock¶ AWS::EC2::VPCCidrBlock.CidrBlockType: string or @aws-cdk/cdk.Token(optional)
-
VPCDHCPOptionsAssociationResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCDHCPOptionsAssociationResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCDHCPOptionsAssociationResource;
const { cloudformation.VPCDHCPOptionsAssociationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCDHCPOptionsAssociationResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisVPCDHCPOptionsAssociationResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
VPCDHCPOptionsAssociationResourceProps) – the properties of thisVPCDHCPOptionsAssociationResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: VPCDHCPOptionsAssociationResourceProps(readonly)
-
vpcdhcpOptionsAssociationName¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
VPCDHCPOptionsAssociationResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCDHCPOptionsAssociationResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCDHCPOptionsAssociationResourceProps;
// cloudformation.VPCDHCPOptionsAssociationResourceProps is an interfaceimport { cloudformation.VPCDHCPOptionsAssociationResourceProps } from '@aws-cdk/aws-ec2';
-
dhcpOptionsId¶ AWS::EC2::VPCDHCPOptionsAssociation.DhcpOptionsIdType: string or @aws-cdk/cdk.Token
-
vpcId¶ AWS::EC2::VPCDHCPOptionsAssociation.VpcIdType: string or @aws-cdk/cdk.Token
-
VPCEndpointConnectionNotificationResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCEndpointConnectionNotificationResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCEndpointConnectionNotificationResource;
const { cloudformation.VPCEndpointConnectionNotificationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCEndpointConnectionNotificationResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisVPCEndpointConnectionNotificationResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
VPCEndpointConnectionNotificationResourceProps) – the properties of thisVPCEndpointConnectionNotificationResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: VPCEndpointConnectionNotificationResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
VPCEndpointConnectionNotificationResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCEndpointConnectionNotificationResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCEndpointConnectionNotificationResourceProps;
// cloudformation.VPCEndpointConnectionNotificationResourceProps is an interfaceimport { cloudformation.VPCEndpointConnectionNotificationResourceProps } from '@aws-cdk/aws-ec2';
-
connectionEvents¶ AWS::EC2::VPCEndpointConnectionNotification.ConnectionEventsType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[]
-
connectionNotificationArn¶ AWS::EC2::VPCEndpointConnectionNotification.ConnectionNotificationArnType: string or @aws-cdk/cdk.Token
-
serviceId¶ AWS::EC2::VPCEndpointConnectionNotification.ServiceIdType: string or @aws-cdk/cdk.Token(optional)
-
vpcEndpointId¶ AWS::EC2::VPCEndpointConnectionNotification.VPCEndpointIdType: string or @aws-cdk/cdk.Token(optional)
-
VPCEndpointResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCEndpointResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCEndpointResource;
const { cloudformation.VPCEndpointResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCEndpointResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisVPCEndpointResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
VPCEndpointResourceProps) – the properties of thisVPCEndpointResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: VPCEndpointResourceProps(readonly)
-
vpcEndpointCreationTimestamp¶ Type: string (readonly)
-
vpcEndpointDnsEntries¶ Type: VPCEndpointDnsEntries(readonly)
-
vpcEndpointId¶ Type: string (readonly)
-
vpcEndpointNetworkInterfaceIds¶ Type: VPCEndpointNetworkInterfaceIds(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
VPCEndpointResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCEndpointResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCEndpointResourceProps;
// cloudformation.VPCEndpointResourceProps is an interfaceimport { cloudformation.VPCEndpointResourceProps } from '@aws-cdk/aws-ec2';
-
serviceName¶ AWS::EC2::VPCEndpoint.ServiceNameType: string or @aws-cdk/cdk.Token
-
vpcId¶ AWS::EC2::VPCEndpoint.VpcIdType: string or @aws-cdk/cdk.Token
-
policyDocument¶ AWS::EC2::VPCEndpoint.PolicyDocumentType: json or @aws-cdk/cdk.Token(optional)
-
privateDnsEnabled¶ AWS::EC2::VPCEndpoint.PrivateDnsEnabledType: boolean or @aws-cdk/cdk.Token(optional)
-
routeTableIds¶ AWS::EC2::VPCEndpoint.RouteTableIdsType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
-
securityGroupIds¶ AWS::EC2::VPCEndpoint.SecurityGroupIdsType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
-
subnetIds¶ AWS::EC2::VPCEndpoint.SubnetIdsType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
-
vpcEndpointType¶ AWS::EC2::VPCEndpoint.VpcEndpointTypeType: string or @aws-cdk/cdk.Token(optional)
-
VPCEndpointServicePermissionsResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCEndpointServicePermissionsResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCEndpointServicePermissionsResource;
const { cloudformation.VPCEndpointServicePermissionsResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCEndpointServicePermissionsResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisVPCEndpointServicePermissionsResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
VPCEndpointServicePermissionsResourceProps) – the properties of thisVPCEndpointServicePermissionsResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: VPCEndpointServicePermissionsResourceProps(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
VPCEndpointServicePermissionsResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCEndpointServicePermissionsResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCEndpointServicePermissionsResourceProps;
// cloudformation.VPCEndpointServicePermissionsResourceProps is an interfaceimport { cloudformation.VPCEndpointServicePermissionsResourceProps } from '@aws-cdk/aws-ec2';
-
serviceId¶ AWS::EC2::VPCEndpointServicePermissions.ServiceIdType: string or @aws-cdk/cdk.Token
-
allowedPrincipals¶ AWS::EC2::VPCEndpointServicePermissions.AllowedPrincipalsType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[] (optional)
-
VPCGatewayAttachmentResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCGatewayAttachmentResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCGatewayAttachmentResource;
const { cloudformation.VPCGatewayAttachmentResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCGatewayAttachmentResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisVPCGatewayAttachmentResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
VPCGatewayAttachmentResourceProps) – the properties of thisVPCGatewayAttachmentResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: VPCGatewayAttachmentResourceProps(readonly)
-
vpcGatewayAttachmentName¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
VPCGatewayAttachmentResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCGatewayAttachmentResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCGatewayAttachmentResourceProps;
// cloudformation.VPCGatewayAttachmentResourceProps is an interfaceimport { cloudformation.VPCGatewayAttachmentResourceProps } from '@aws-cdk/aws-ec2';
-
vpcId¶ AWS::EC2::VPCGatewayAttachment.VpcIdType: string or @aws-cdk/cdk.Token
-
internetGatewayId¶ AWS::EC2::VPCGatewayAttachment.InternetGatewayIdType: string or @aws-cdk/cdk.Token(optional)
-
vpnGatewayId¶ AWS::EC2::VPCGatewayAttachment.VpnGatewayIdType: string or @aws-cdk/cdk.Token(optional)
-
VPCPeeringConnectionResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCPeeringConnectionResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCPeeringConnectionResource;
const { cloudformation.VPCPeeringConnectionResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCPeeringConnectionResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisVPCPeeringConnectionResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
VPCPeeringConnectionResourceProps) – the properties of thisVPCPeeringConnectionResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: VPCPeeringConnectionResourceProps(readonly)
-
vpcPeeringConnectionName¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
VPCPeeringConnectionResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCPeeringConnectionResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCPeeringConnectionResourceProps;
// cloudformation.VPCPeeringConnectionResourceProps is an interfaceimport { cloudformation.VPCPeeringConnectionResourceProps } from '@aws-cdk/aws-ec2';
-
peerVpcId¶ AWS::EC2::VPCPeeringConnection.PeerVpcIdType: string or @aws-cdk/cdk.Token
-
vpcId¶ AWS::EC2::VPCPeeringConnection.VpcIdType: string or @aws-cdk/cdk.Token
-
peerOwnerId¶ AWS::EC2::VPCPeeringConnection.PeerOwnerIdType: string or @aws-cdk/cdk.Token(optional)
-
peerRegion¶ AWS::EC2::VPCPeeringConnection.PeerRegionType: string or @aws-cdk/cdk.Token(optional)
-
peerRoleArn¶ AWS::EC2::VPCPeeringConnection.PeerRoleArnType: string or @aws-cdk/cdk.Token(optional)
AWS::EC2::VPCPeeringConnection.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
VPCResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCResource;
const { cloudformation.VPCResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPCResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisVPCResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
VPCResourceProps) – the properties of thisVPCResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: VPCResourceProps(readonly)
-
vpcCidrBlock¶ Type: string (readonly)
-
vpcCidrBlockAssociations¶ Type: VPCCidrBlockAssociations(readonly)
-
vpcDefaultNetworkAcl¶ Type: string (readonly)
-
vpcDefaultSecurityGroup¶ Type: string (readonly)
-
vpcId¶ Type: string (readonly)
-
vpcIpv6CidrBlocks¶ Type: VPCIpv6CidrBlocks(readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
VPCResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPCResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPCResourceProps;
// cloudformation.VPCResourceProps is an interfaceimport { cloudformation.VPCResourceProps } from '@aws-cdk/aws-ec2';
-
cidrBlock¶ AWS::EC2::VPC.CidrBlockType: string or @aws-cdk/cdk.Token
-
enableDnsHostnames¶ AWS::EC2::VPC.EnableDnsHostnamesType: boolean or @aws-cdk/cdk.Token(optional)
-
enableDnsSupport¶ AWS::EC2::VPC.EnableDnsSupportType: boolean or @aws-cdk/cdk.Token(optional)
-
instanceTenancy¶ AWS::EC2::VPC.InstanceTenancyType: string or @aws-cdk/cdk.Token(optional)
AWS::EC2::VPC.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
VPNConnectionResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPNConnectionResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNConnectionResource;
const { cloudformation.VPNConnectionResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPNConnectionResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisVPNConnectionResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
VPNConnectionResourceProps) – the properties of thisVPNConnectionResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: VPNConnectionResourceProps(readonly)
-
vpnConnectionName¶ Type: string (readonly)
-
class
VpnTunnelOptionsSpecificationProperty¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNConnectionResource.VpnTunnelOptionsSpecificationProperty;
// cloudformation.VPNConnectionResource.VpnTunnelOptionsSpecificationProperty is an interfaceimport { cloudformation.VPNConnectionResource.VpnTunnelOptionsSpecificationProperty } from '@aws-cdk/aws-ec2';
VPNConnectionResource.VpnTunnelOptionsSpecificationProperty.PreSharedKeyType: string or @aws-cdk/cdk.Token(optional)
-
tunnelInsideCidr¶ VPNConnectionResource.VpnTunnelOptionsSpecificationProperty.TunnelInsideCidrType: string or @aws-cdk/cdk.Token(optional)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
VPNConnectionResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPNConnectionResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNConnectionResourceProps;
// cloudformation.VPNConnectionResourceProps is an interfaceimport { cloudformation.VPNConnectionResourceProps } from '@aws-cdk/aws-ec2';
-
customerGatewayId¶ AWS::EC2::VPNConnection.CustomerGatewayIdType: string or @aws-cdk/cdk.Token
-
type¶ AWS::EC2::VPNConnection.TypeType: string or @aws-cdk/cdk.Token
-
vpnGatewayId¶ AWS::EC2::VPNConnection.VpnGatewayIdType: string or @aws-cdk/cdk.Token
-
staticRoutesOnly¶ AWS::EC2::VPNConnection.StaticRoutesOnlyType: boolean or @aws-cdk/cdk.Token(optional)
AWS::EC2::VPNConnection.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
vpnTunnelOptionsSpecifications¶ AWS::EC2::VPNConnection.VpnTunnelOptionsSpecificationsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.TokenorVpnTunnelOptionsSpecificationProperty)[] (optional)
-
VPNConnectionRouteResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPNConnectionRouteResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNConnectionRouteResource;
const { cloudformation.VPNConnectionRouteResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPNConnectionRouteResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisVPNConnectionRouteResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
VPNConnectionRouteResourceProps) – the properties of thisVPNConnectionRouteResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: VPNConnectionRouteResourceProps(readonly)
-
vpnConnectionRouteName¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
VPNConnectionRouteResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPNConnectionRouteResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNConnectionRouteResourceProps;
// cloudformation.VPNConnectionRouteResourceProps is an interfaceimport { cloudformation.VPNConnectionRouteResourceProps } from '@aws-cdk/aws-ec2';
-
destinationCidrBlock¶ AWS::EC2::VPNConnectionRoute.DestinationCidrBlockType: string or @aws-cdk/cdk.Token
-
vpnConnectionId¶ AWS::EC2::VPNConnectionRoute.VpnConnectionIdType: string or @aws-cdk/cdk.Token
-
VPNGatewayResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPNGatewayResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNGatewayResource;
const { cloudformation.VPNGatewayResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPNGatewayResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisVPNGatewayResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
VPNGatewayResourceProps) – the properties of thisVPNGatewayResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: VPNGatewayResourceProps(readonly)
-
vpnGatewayName¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
VPNGatewayResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPNGatewayResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNGatewayResourceProps;
// cloudformation.VPNGatewayResourceProps is an interfaceimport { cloudformation.VPNGatewayResourceProps } from '@aws-cdk/aws-ec2';
-
type¶ AWS::EC2::VPNGateway.TypeType: string or @aws-cdk/cdk.Token
-
amazonSideAsn¶ AWS::EC2::VPNGateway.AmazonSideAsnType: number or @aws-cdk/cdk.Token(optional)
AWS::EC2::VPNGateway.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
VPNGatewayRoutePropagationResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPNGatewayRoutePropagationResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNGatewayRoutePropagationResource;
const { cloudformation.VPNGatewayRoutePropagationResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VPNGatewayRoutePropagationResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisVPNGatewayRoutePropagationResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
VPNGatewayRoutePropagationResourceProps) – the properties of thisVPNGatewayRoutePropagationResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: VPNGatewayRoutePropagationResourceProps(readonly)
-
vpnGatewayRoutePropagationName¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
VPNGatewayRoutePropagationResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.VPNGatewayRoutePropagationResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VPNGatewayRoutePropagationResourceProps;
// cloudformation.VPNGatewayRoutePropagationResourceProps is an interfaceimport { cloudformation.VPNGatewayRoutePropagationResourceProps } from '@aws-cdk/aws-ec2';
-
routeTableIds¶ AWS::EC2::VPNGatewayRoutePropagation.RouteTableIdsType: @aws-cdk/cdk.Tokenor (string or@aws-cdk/cdk.Token)[]
-
vpnGatewayId¶ AWS::EC2::VPNGatewayRoutePropagation.VpnGatewayIdType: string or @aws-cdk/cdk.Token
-
VolumeAttachmentResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.VolumeAttachmentResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VolumeAttachmentResource;
const { cloudformation.VolumeAttachmentResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VolumeAttachmentResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisVolumeAttachmentResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
VolumeAttachmentResourceProps) – the properties of thisVolumeAttachmentResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: VolumeAttachmentResourceProps(readonly)
-
volumeAttachmentId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
VolumeAttachmentResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.VolumeAttachmentResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VolumeAttachmentResourceProps;
// cloudformation.VolumeAttachmentResourceProps is an interfaceimport { cloudformation.VolumeAttachmentResourceProps } from '@aws-cdk/aws-ec2';
-
device¶ AWS::EC2::VolumeAttachment.DeviceType: string or @aws-cdk/cdk.Token
-
instanceId¶ AWS::EC2::VolumeAttachment.InstanceIdType: string or @aws-cdk/cdk.Token
-
volumeId¶ AWS::EC2::VolumeAttachment.VolumeIdType: string or @aws-cdk/cdk.Token
-
VolumeResource¶
-
class
@aws-cdk/aws-ec2.cloudformation.VolumeResource(parent, name, properties)¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VolumeResource;
const { cloudformation.VolumeResource } = require('@aws-cdk/aws-ec2');
import { cloudformation.VolumeResource } from '@aws-cdk/aws-ec2';
Extends: Parameters: - parent (
@aws-cdk/cdk.Construct) – thecdk.ConstructthisVolumeResourceis a part of - name (string) – the name of the resource in the
cdk.Constructtree - properties (
VolumeResourceProps) – the properties of thisVolumeResource
-
renderProperties(properties) → string => any¶ Overrides
@aws-cdk/cdk.Resource.renderProperties()Protected method
Parameters: properties (any) – Return type: string => any
-
resourceTypeName¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
propertyOverrides¶ Type: VolumeResourceProps(readonly)
-
volumeId¶ Type: string (readonly)
-
addChild(child, childName)¶ Inherited from
@aws-cdk/cdk.ConstructAdds a child construct to this node.
Protected method
Parameters: - child (
@aws-cdk/cdk.Construct) – The child construct - childName (string) –
Returns: The resolved path part name of the child
- child (
-
addError(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds an { error: <message> } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
Parameters: message (string) – The error message. Return type: @aws-cdk/cdk.Construct
-
addInfo(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { “aws:cdk:info”: <message> } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
Parameters: message (string) – The info message. Return type: @aws-cdk/cdk.Construct
-
addMetadata(type, data[, from]) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a metadata entry to this construct.
Entries are arbitrary values and will also include a stack trace to allow tracing back to
the code location for when the entry was added. It can be used, for example, to include source
mapping in CloudFormation templates to improve diagnostics.
Parameters: - type (string) – a string denoting the type of metadata
- data (any) – the value of the metadata (can be a Token). If null/undefined, metadata will not be added.
- from (any (optional)) – a function under which to restrict the metadata entry’s stack trace (defaults to this.addMetadata)
Return type:
-
addWarning(message) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructAdds a { warning: <message> } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in –strict mode.
Parameters: message (string) – The warning message. Return type: @aws-cdk/cdk.Construct
-
ancestors([upTo]) → @aws-cdk/cdk.Construct[]¶ Inherited from
@aws-cdk/cdk.ConstructReturn the ancestors (including self) of this Construct up until and excluding the indicated component
Parameters: upTo ( @aws-cdk/cdk.Construct(optional)) –Return type: @aws-cdk/cdk.Construct[]
-
findChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path
Throws an exception if the descendant is not found.
Parameters: path (string) – Returns: Child with the given path. Return type: @aws-cdk/cdk.Construct
-
getContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieves a value from tree context.
Context is usually initialized at the root, but can be overridden at any point in the tree.
Parameters: key (string) – The context key Returns: The context value or undefined Return type: any
-
lock()¶ Inherited from
@aws-cdk/cdk.ConstructLocks this construct from allowing more children to be added. After this
call, no more children can be added to this construct or to any children.
Protected method
-
requireContext(key) → any¶ Inherited from
@aws-cdk/cdk.ConstructRetrieve a value from tree-global context
It is an error if the context object is not available.
Parameters: key (string) – Return type: any
-
required(props, name) → any¶ Inherited from
@aws-cdk/cdk.ConstructThrows if the props bag doesn’t include the property name.
In the future we can add some type-checking here, maybe even auto-generate during compilation.
Protected method
Parameters: - props (any) – The props bag.
- name (string) – The name of the required property.
Return type: any
-
setContext(key, value)¶ Inherited from
@aws-cdk/cdk.ConstructThis can be used to set contextual values.
Context must be set before any children are added, since children may consult context info during construction.
If the key already exists, it will be overridden.
Parameters: - key (string) – The context key
- value (any) – The context value
-
toString() → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string representation of this construct.
Return type: string
-
toTreeString([depth]) → string¶ Inherited from
@aws-cdk/cdk.ConstructReturns a string with a tree representation of this construct and it’s children.
Parameters: depth (number (optional)) – Return type: string
-
tryFindChild(path) → @aws-cdk/cdk.Construct¶ Inherited from
@aws-cdk/cdk.ConstructReturn a descendant by path, or undefined
Parameters: path (string) – Returns: a child by path or undefined if not found. Return type: @aws-cdk/cdk.Construct(optional)
-
unlock()¶ Inherited from
@aws-cdk/cdk.ConstructUnlocks this costruct and allows mutations (adding children).
Protected method
-
validate() → string[]¶ Inherited from
@aws-cdk/cdk.ConstructThis method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
Returns: An array of validation error messages, or an empty array if there the construct is valid. Return type: string[]
-
validateTree() → @aws-cdk/cdk.ValidationError[]¶ Inherited from
@aws-cdk/cdk.ConstructInvokes ‘validate’ on all child constructs and then on this construct (depth-first).
Returns: A list of validation errors. If the list is empty, all constructs are valid. Return type: @aws-cdk/cdk.ValidationError[]
-
children¶ Inherited from
@aws-cdk/cdk.ConstructAll direct children of this construct.
Type: @aws-cdk/cdk.Construct[] (readonly)
-
id¶ Inherited from
@aws-cdk/cdk.ConstructThe local id of the construct.
This id is unique amongst its siblings.
To obtain a tree-global unique id for this construct, use uniqueId.
Type: string (readonly)
-
locked¶ Inherited from
@aws-cdk/cdk.ConstructReturns true if this construct or any of it’s parent constructs are
locked.
Protected property
Type: boolean (readonly)
-
metadata¶ Inherited from
@aws-cdk/cdk.ConstructAn array of metadata objects associated with this construct.
This can be used, for example, to implement support for deprecation notices, source mapping, etc.
Type: @aws-cdk/cdk.MetadataEntry[] (readonly)
-
path¶ Inherited from
@aws-cdk/cdk.ConstructThe full path of this construct in the tree.
Components are separated by ‘/’.
Type: string (readonly)
-
uniqueId¶ Inherited from
@aws-cdk/cdk.ConstructA tree-global unique alphanumeric identifier for this construct.
Includes all components of the tree.
Type: string (readonly)
-
parent¶ Inherited from
@aws-cdk/cdk.ConstructReturns the parent of this node or undefined if this is a root node.
Type: @aws-cdk/cdk.Construct(optional) (readonly)
-
ref¶ Inherited from
@aws-cdk/cdk.ReferenceableReturns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.
Type: string (readonly)
-
addDeletionOverride(path)¶ Inherited from
@aws-cdk/cdk.ResourceSyntactic sugar for addOverride(path, undefined).
Parameters: path (string) – The path of the value to delete
-
addDependency(*other)¶ Inherited from
@aws-cdk/cdk.ResourceAdds a dependency on another resource.
Parameters: *other ( @aws-cdk/cdk.IDependable) – The other resource.
-
addOverride(path, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
“Properties.” (i.e. Properties.TopicName).
Parameters: - path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
- value (any) – The value. Could be primitive or complex.
-
addPropertyDeletionOverride(propertyPath)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override that deletes the value of a property from the resource definition.
Parameters: propertyPath (string) – The path to the property.
-
addPropertyOverride(propertyPath, value)¶ Inherited from
@aws-cdk/cdk.ResourceAdds an override to a resource property.
Syntactic sugar for addOverride(“Properties.<…>”, value).
Parameters: - propertyPath (string) – The path of the property
- value (any) – The value
-
getAtt(attributeName) → @aws-cdk/cdk.CloudFormationToken¶ Inherited from
@aws-cdk/cdk.ResourceReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Parameters: attributeName (string) – The name of the attribute. Return type: @aws-cdk/cdk.CloudFormationToken
-
toCloudFormation() → json¶ Inherited from
@aws-cdk/cdk.ResourceEmits CloudFormation for this resource.
Return type: json
-
options¶ Inherited from
@aws-cdk/cdk.ResourceOptions for this resource, such as condition, update policy etc.
Type: @aws-cdk/cdk.ResourceOptions(readonly)
-
properties¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource properties.
This object is rendered via a call to “renderProperties(this.properties)”.
Protected property
Type: any (readonly)
-
resourceType¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource type.
Type: string (readonly)
-
untypedPropertyOverrides¶ Inherited from
@aws-cdk/cdk.ResourceAWS resource property overrides.
During synthesis, the method “renderProperties(this.overrides)” is called
with this object, and merged on top of the output of
“renderProperties(this.properties)”.
Derived classes should expose a strongly-typed version of this object as
a public property called propertyOverrides.
Protected property
Type: any (readonly)
-
creationStackTrace¶ Inherited from
@aws-cdk/cdk.StackElementType: string[] (readonly)
-
dependencyElements¶ Inherited from
@aws-cdk/cdk.StackElementReturns the set of all stack elements (resources, parameters, conditions)
that should be added when a resource “depends on” this construct.
Type: @aws-cdk/cdk.IDependable[] (readonly)
-
logicalId¶ Inherited from
@aws-cdk/cdk.StackElementThe logical ID for this CloudFormation stack element
Type: string (readonly)
-
stackPath¶ Inherited from
@aws-cdk/cdk.StackElementReturn the path with respect to the stack
Type: string (readonly)
-
stack¶ Inherited from
@aws-cdk/cdk.StackElementThe stack this Construct has been made a part of
Protected property
Type: @aws-cdk/cdk.Stack
- parent (
VolumeResourceProps (interface)¶
-
class
@aws-cdk/aws-ec2.cloudformation.VolumeResourceProps¶ Language-specific names:
using Amazon.CDK.AWS.EC2;
import software.amazon.awscdk.services.ec2.cloudformation.VolumeResourceProps;
// cloudformation.VolumeResourceProps is an interfaceimport { cloudformation.VolumeResourceProps } from '@aws-cdk/aws-ec2';
-
availabilityZone¶ AWS::EC2::Volume.AvailabilityZoneType: string or @aws-cdk/cdk.Token
-
autoEnableIo¶ AWS::EC2::Volume.AutoEnableIOType: boolean or @aws-cdk/cdk.Token(optional)
-
encrypted¶ AWS::EC2::Volume.EncryptedType: boolean or @aws-cdk/cdk.Token(optional)
-
iops¶ AWS::EC2::Volume.IopsType: number or @aws-cdk/cdk.Token(optional)
-
kmsKeyId¶ AWS::EC2::Volume.KmsKeyIdType: string or @aws-cdk/cdk.Token(optional)
-
size¶ AWS::EC2::Volume.SizeType: number or @aws-cdk/cdk.Token(optional)
-
snapshotId¶ AWS::EC2::Volume.SnapshotIdType: string or @aws-cdk/cdk.Token(optional)
AWS::EC2::Volume.TagsType: @aws-cdk/cdk.Tokenor (@aws-cdk/cdk.Tokenor@aws-cdk/cdk.Tag)[] (optional)
-
volumeType¶ AWS::EC2::Volume.VolumeTypeType: string or @aws-cdk/cdk.Token(optional)
-